/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-01-15 20:55:50 UTC
  • Revision ID: teddy@recompile.se-20120115205550-i9dfhet4qjcroxru
Use the new Client.LastCheckerStatus property.
* mandos-monitor (MandosClientWidget.last_checker_failed): Removed.
  (MandosClientWidget.property_changed): Check for LastCheckerStatus
                                         and enable timer if failure
                                         is indicated.
  (MandosClientWidget.update): Use LastCheckerStatus property instead
                               of last_checker_failed.

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
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
22
# Contact the authors at <mandos@recompile.se>.
24
23
# 
25
24
 
26
25
from __future__ import (division, absolute_import, print_function,
27
26
                        unicode_literals)
28
 
try:
29
 
    from future_builtins import *
30
 
except ImportError:
31
 
    pass
32
27
 
33
28
import sys
34
29
import os
 
30
import signal
35
31
 
36
32
import datetime
37
33
 
39
35
import urwid
40
36
 
41
37
from dbus.mainloop.glib import DBusGMainLoop
42
 
try:
43
 
    import gobject
44
 
except ImportError:
45
 
    from gi.repository import GObject as gobject
 
38
import gobject
46
39
 
47
40
import dbus
48
41
 
 
42
import UserList
 
43
 
49
44
import locale
50
45
 
51
 
if sys.version_info[0] == 2:
52
 
    str = unicode
53
 
 
54
46
locale.setlocale(locale.LC_ALL, '')
55
47
 
56
48
import logging
60
52
domain = 'se.recompile'
61
53
server_interface = domain + '.Mandos'
62
54
client_interface = domain + '.Mandos.Client'
63
 
version = "1.6.4"
 
55
version = "1.5.2"
 
56
 
 
57
# Always run in monochrome mode
 
58
urwid.curses_display.curses.has_colors = lambda : False
 
59
 
 
60
# Urwid doesn't support blinking, but we want it.  Since we have no
 
61
# use for underline on its own, we make underline also always blink.
 
62
urwid.curses_display.curses.A_UNDERLINE |= (
 
63
    urwid.curses_display.curses.A_BLINK)
64
64
 
65
65
def isoformat_to_datetime(iso):
66
66
    "Parse an ISO 8601 date string to a datetime.datetime()"
83
83
    properties and calls a hook function when any of them are
84
84
    changed.
85
85
    """
86
 
    def __init__(self, proxy_object=None, properties=None, **kwargs):
 
86
    def __init__(self, proxy_object=None, *args, **kwargs):
87
87
        self.proxy = proxy_object # Mandos Client proxy object
88
 
        self.properties = dict() if properties is None else properties
 
88
        
 
89
        self.properties = dict()
89
90
        self.property_changed_match = (
90
91
            self.proxy.connect_to_signal("PropertyChanged",
91
 
                                         self._property_changed,
 
92
                                         self.property_changed,
92
93
                                         client_interface,
93
94
                                         byte_arrays=True))
94
95
        
95
 
        if properties is None:
96
 
            self.properties.update(
97
 
                self.proxy.GetAll(client_interface,
98
 
                                  dbus_interface
99
 
                                  = dbus.PROPERTIES_IFACE))
100
 
        
101
 
        super(MandosClientPropertyCache, self).__init__(**kwargs)
102
 
    
103
 
    def _property_changed(self, property, value):
104
 
        """Helper which takes positional arguments"""
105
 
        return self.property_changed(property=property, value=value)
 
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)
106
103
    
107
104
    def property_changed(self, property=None, value=None):
108
105
        """This is called whenever we get a PropertyChanged signal
111
108
        # Update properties dict with new value
112
109
        self.properties[property] = value
113
110
    
114
 
    def delete(self):
 
111
    def delete(self, *args, **kwargs):
115
112
        self.property_changed_match.remove()
 
113
        super(MandosClientPropertyCache, self).__init__(
 
114
            *args, **kwargs)
116
115
 
117
116
 
118
117
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
120
119
    """
121
120
    
122
121
    def __init__(self, server_proxy_object=None, update_hook=None,
123
 
                 delete_hook=None, logger=None, **kwargs):
 
122
                 delete_hook=None, logger=None, *args, **kwargs):
124
123
        # Called on update
125
124
        self.update_hook = update_hook
126
125
        # Called on delete
131
130
        self.logger = logger
132
131
        
133
132
        self._update_timer_callback_tag = None
 
133
        self._update_timer_callback_lock = 0
134
134
        
135
135
        # The widget shown normally
136
136
        self._text_widget = urwid.Text("")
137
137
        # The widget shown when we have focus
138
138
        self._focus_text_widget = urwid.Text("")
139
 
        super(MandosClientWidget, self).__init__(**kwargs)
 
139
        super(MandosClientWidget, self).__init__(
 
140
            update_hook=update_hook, delete_hook=delete_hook,
 
141
            *args, **kwargs)
140
142
        self.update()
141
143
        self.opened = False
142
144
        
 
145
        last_checked_ok = isoformat_to_datetime(self.properties
 
146
                                                ["LastCheckedOK"])
 
147
        
 
148
        if self.properties ["LastCheckerStatus"] != 0:
 
149
            self.using_timer(True)
 
150
        
 
151
        if self.need_approval:
 
152
            self.using_timer(True)
 
153
        
143
154
        self.match_objects = (
144
155
            self.proxy.connect_to_signal("CheckerCompleted",
145
156
                                         self.checker_completed,
161
172
                                         self.rejected,
162
173
                                         client_interface,
163
174
                                         byte_arrays=True))
164
 
        #self.logger('Created client {0}'
165
 
        #            .format(self.properties["Name"]))
 
175
        #self.logger('Created client %s' % (self.properties["Name"]))
 
176
    
 
177
    def property_changed(self, property=None, value=None):
 
178
        super(self, MandosClientWidget).property_changed(property,
 
179
                                                         value)
 
180
        if property == "ApprovalPending":
 
181
            using_timer(bool(value))
 
182
        if property == "LastCheckerStatus":
 
183
            using_timer(value != 0)
 
184
            #self.logger('Checker for client %s (command "%s")'
 
185
            #            ' was successful'
 
186
            #            % (self.properties["Name"], command))
166
187
    
167
188
    def using_timer(self, flag):
168
189
        """Call this method with True or False when timer should be
169
190
        activated or deactivated.
170
191
        """
171
 
        if flag and self._update_timer_callback_tag is None:
 
192
        old = self._update_timer_callback_lock
 
193
        if flag:
 
194
            self._update_timer_callback_lock += 1
 
195
        else:
 
196
            self._update_timer_callback_lock -= 1
 
197
        if old == 0 and self._update_timer_callback_lock:
172
198
            # Will update the shown timer value every second
173
199
            self._update_timer_callback_tag = (gobject.timeout_add
174
200
                                               (1000,
175
201
                                                self.update_timer))
176
 
        elif not (flag or self._update_timer_callback_tag is None):
 
202
        elif old and self._update_timer_callback_lock == 0:
177
203
            gobject.source_remove(self._update_timer_callback_tag)
178
204
            self._update_timer_callback_tag = None
179
205
    
183
209
            return
184
210
        # Checker failed
185
211
        if os.WIFEXITED(condition):
186
 
            self.logger('Checker for client {0} (command "{1}")'
187
 
                        ' failed with exit code {2}'
188
 
                        .format(self.properties["Name"], command,
189
 
                                os.WEXITSTATUS(condition)))
 
212
            self.logger('Checker for client %s (command "%s")'
 
213
                        ' failed with exit code %s'
 
214
                        % (self.properties["Name"], command,
 
215
                           os.WEXITSTATUS(condition)))
190
216
        elif os.WIFSIGNALED(condition):
191
 
            self.logger('Checker for client {0} (command "{1}") was'
192
 
                        ' killed by signal {2}'
193
 
                        .format(self.properties["Name"], command,
194
 
                                os.WTERMSIG(condition)))
 
217
            self.logger('Checker for client %s (command "%s")'
 
218
                        ' was killed by signal %s'
 
219
                        % (self.properties["Name"], command,
 
220
                           os.WTERMSIG(condition)))
195
221
        elif os.WCOREDUMP(condition):
196
 
            self.logger('Checker for client {0} (command "{1}")'
 
222
            self.logger('Checker for client %s (command "%s")'
197
223
                        ' dumped core'
198
 
                        .format(self.properties["Name"], command))
 
224
                        % (self.properties["Name"], command))
199
225
        else:
200
 
            self.logger('Checker for client {0} completed'
201
 
                        ' mysteriously'
202
 
                        .format(self.properties["Name"]))
 
226
            self.logger('Checker for client %s completed'
 
227
                        ' mysteriously')
203
228
        self.update()
204
229
    
205
230
    def checker_started(self, command):
206
231
        """Server signals that a checker started. This could be useful
207
232
           to log in the future. """
208
 
        #self.logger('Client {0} started checker "{1}"'
209
 
        #            .format(self.properties["Name"],
210
 
        #                    str(command)))
 
233
        #self.logger('Client %s started checker "%s"'
 
234
        #            % (self.properties["Name"], unicode(command)))
211
235
        pass
212
236
    
213
237
    def got_secret(self):
214
 
        self.logger('Client {0} received its secret'
215
 
                    .format(self.properties["Name"]))
 
238
        self.logger('Client %s received its secret'
 
239
                    % self.properties["Name"])
216
240
    
217
241
    def need_approval(self, timeout, default):
218
242
        if not default:
219
 
            message = 'Client {0} needs approval within {1} seconds'
 
243
            message = 'Client %s needs approval within %s seconds'
220
244
        else:
221
 
            message = 'Client {0} will get its secret in {1} seconds'
222
 
        self.logger(message.format(self.properties["Name"],
223
 
                                   timeout/1000))
 
245
            message = 'Client %s will get its secret in %s seconds'
 
246
        self.logger(message
 
247
                    % (self.properties["Name"], timeout/1000))
 
248
        self.using_timer(True)
224
249
    
225
250
    def rejected(self, reason):
226
 
        self.logger('Client {0} was rejected; reason: {1}'
227
 
                    .format(self.properties["Name"], reason))
 
251
        self.logger('Client %s was rejected; reason: %s'
 
252
                    % (self.properties["Name"], reason))
228
253
    
229
254
    def selectable(self):
230
255
        """Make this a "selectable" widget.
252
277
                          "bold-underline-blink":
253
278
                              "bold-underline-blink-standout",
254
279
                          }
255
 
        
 
280
 
256
281
        # Rebuild focus and non-focus widgets using current properties
257
 
        
 
282
 
258
283
        # Base part of a client. Name!
259
 
        base = '{name}: '.format(name=self.properties["Name"])
 
284
        base = ('%(name)s: '
 
285
                      % {"name": self.properties["Name"]})
260
286
        if not self.properties["Enabled"]:
261
287
            message = "DISABLED"
262
 
            self.using_timer(False)
263
288
        elif self.properties["ApprovalPending"]:
264
289
            timeout = datetime.timedelta(milliseconds
265
290
                                         = self.properties
267
292
            last_approval_request = isoformat_to_datetime(
268
293
                self.properties["LastApprovalRequest"])
269
294
            if last_approval_request is not None:
270
 
                timer = max(timeout - (datetime.datetime.utcnow()
271
 
                                       - last_approval_request),
272
 
                            datetime.timedelta())
 
295
                timer = timeout - (datetime.datetime.utcnow()
 
296
                                   - last_approval_request)
273
297
            else:
274
298
                timer = datetime.timedelta()
275
299
            if self.properties["ApprovedByDefault"]:
276
 
                message = "Approval in {0}. (d)eny?"
 
300
                message = "Approval in %s. (d)eny?"
277
301
            else:
278
 
                message = "Denial in {0}. (a)pprove?"
279
 
            message = message.format(str(timer).rsplit(".", 1)[0])
280
 
            self.using_timer(True)
 
302
                message = "Denial in %s. (a)pprove?"
 
303
            message = message % unicode(timer).rsplit(".", 1)[0]
281
304
        elif self.properties["LastCheckerStatus"] != 0:
282
 
            # When checker has failed, show timer until client expires
 
305
            # When checker has failed, print a timer until client expires
283
306
            expires = self.properties["Expires"]
284
307
            if expires == "":
285
308
                timer = datetime.timedelta(0)
286
309
            else:
287
 
                expires = (datetime.datetime.strptime
288
 
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
289
 
                timer = max(expires - datetime.datetime.utcnow(),
290
 
                            datetime.timedelta())
 
310
                expires = datetime.datetime.strptime(expires,
 
311
                                                     '%Y-%m-%dT%H:%M:%S.%f')
 
312
                timer = expires - datetime.datetime.utcnow()
291
313
            message = ('A checker has failed! Time until client'
292
 
                       ' gets disabled: {0}'
293
 
                       .format(str(timer).rsplit(".", 1)[0]))
294
 
            self.using_timer(True)
 
314
                       ' gets disabled: %s'
 
315
                           % unicode(timer).rsplit(".", 1)[0])
295
316
        else:
296
317
            message = "enabled"
297
 
            self.using_timer(False)
298
 
        self._text = "{0}{1}".format(base, message)
299
 
        
 
318
        self._text = "%s%s" % (base, message)
 
319
            
300
320
        if not urwid.supports_unicode():
301
321
            self._text = self._text.encode("ascii", "replace")
302
322
        textlist = [("normal", self._text)]
319
339
        self.update()
320
340
        return True             # Keep calling this
321
341
    
322
 
    def delete(self, **kwargs):
 
342
    def delete(self, *args, **kwargs):
323
343
        if self._update_timer_callback_tag is not None:
324
344
            gobject.source_remove(self._update_timer_callback_tag)
325
345
            self._update_timer_callback_tag = None
328
348
        self.match_objects = ()
329
349
        if self.delete_hook is not None:
330
350
            self.delete_hook(self)
331
 
        return super(MandosClientWidget, self).delete(**kwargs)
 
351
        return super(MandosClientWidget, self).delete(*args, **kwargs)
332
352
    
333
353
    def render(self, maxcolrow, focus=False):
334
354
        """Render differently if we have focus.
376
396
        else:
377
397
            return key
378
398
    
379
 
    def property_changed(self, property=None, **kwargs):
 
399
    def property_changed(self, property=None, value=None,
 
400
                         *args, **kwargs):
380
401
        """Call self.update() if old value is not new value.
381
402
        This overrides the method from MandosClientPropertyCache"""
382
 
        property_name = str(property)
 
403
        property_name = unicode(property)
383
404
        old_value = self.properties.get(property_name)
384
405
        super(MandosClientWidget, self).property_changed(
385
 
            property=property, **kwargs)
 
406
            property=property, value=value, *args, **kwargs)
386
407
        if self.properties.get(property_name) != old_value:
387
408
            self.update()
388
409
 
392
413
    "down" key presses, thus not allowing any containing widgets to
393
414
    use them as an excuse to shift focus away from this widget.
394
415
    """
395
 
    def keypress(self, *args, **kwargs):
396
 
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
 
416
    def keypress(self, maxcolrow, key):
 
417
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
397
418
        if ret in ("up", "down"):
398
419
            return
399
420
        return ret
412
433
                ("normal",
413
434
                 "default", "default", None),
414
435
                ("bold",
415
 
                 "bold", "default", "bold"),
 
436
                 "default", "default", "bold"),
416
437
                ("underline-blink",
417
 
                 "underline,blink", "default", "underline,blink"),
 
438
                 "default", "default", "underline"),
418
439
                ("standout",
419
 
                 "standout", "default", "standout"),
 
440
                 "default", "default", "standout"),
420
441
                ("bold-underline-blink",
421
 
                 "bold,underline,blink", "default", "bold,underline,blink"),
 
442
                 "default", "default", ("bold", "underline")),
422
443
                ("bold-standout",
423
 
                 "bold,standout", "default", "bold,standout"),
 
444
                 "default", "default", ("bold", "standout")),
424
445
                ("underline-blink-standout",
425
 
                 "underline,blink,standout", "default",
426
 
                 "underline,blink,standout"),
 
446
                 "default", "default", ("underline", "standout")),
427
447
                ("bold-underline-blink-standout",
428
 
                 "bold,underline,blink,standout", "default",
429
 
                 "bold,underline,blink,standout"),
 
448
                 "default", "default", ("bold", "underline",
 
449
                                          "standout")),
430
450
                ))
431
451
        
432
452
        if urwid.supports_unicode():
466
486
        self.main_loop = gobject.MainLoop()
467
487
    
468
488
    def client_not_found(self, fingerprint, address):
469
 
        self.log_message("Client with address {0} and fingerprint"
470
 
                         " {1} could not be found"
471
 
                         .format(address, fingerprint))
 
489
        self.log_message(("Client with address %s and fingerprint %s"
 
490
                          " could not be found" % (address,
 
491
                                                    fingerprint)))
472
492
    
473
493
    def rebuild(self):
474
494
        """This rebuilds the User Interface.
487
507
        self.topwidget = urwid.Pile(self.uilist)
488
508
    
489
509
    def log_message(self, message):
490
 
        """Log message formatted with timestamp"""
491
510
        timestamp = datetime.datetime.now().isoformat()
492
511
        self.log_message_raw(timestamp + ": " + message)
493
512
    
506
525
        self.log_visible = not self.log_visible
507
526
        self.rebuild()
508
527
        #self.log_message("Log visibility changed to: "
509
 
        #                 + str(self.log_visible))
 
528
        #                 + unicode(self.log_visible))
510
529
    
511
530
    def change_log_display(self):
512
531
        """Change type of log display.
528
547
            client = self.clients_dict[path]
529
548
        except KeyError:
530
549
            # not found?
531
 
            self.log_message("Unknown client {0!r} ({1!r}) removed"
532
 
                             .format(name, path))
 
550
            self.log_message("Unknown client %r (%r) removed", name,
 
551
                             path)
533
552
            return
534
553
        client.delete()
535
554
    
552
571
        if path is None:
553
572
            path = client.proxy.object_path
554
573
        self.clients_dict[path] = client
555
 
        self.clients.sort(key=lambda c: c.properties["Name"])
 
574
        self.clients.sort(None, lambda c: c.properties["Name"])
556
575
        self.refresh()
557
576
    
558
577
    def remove_client(self, client, path=None):
560
579
        if path is None:
561
580
            path = client.proxy.object_path
562
581
        del self.clients_dict[path]
 
582
        if not self.clients_dict:
 
583
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
 
584
            # is completely emptied, we need to recreate it.
 
585
            self.clients = urwid.SimpleListWalker([])
 
586
            self.rebuild()
563
587
        self.refresh()
564
588
    
565
589
    def refresh(self):
578
602
        try:
579
603
            mandos_clients = (self.mandos_serv
580
604
                              .GetAllClientsWithProperties())
581
 
            if not mandos_clients:
582
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
583
605
        except dbus.exceptions.DBusException:
584
 
            self.log_message_raw(("bold", "Note: No Mandos server running."))
585
606
            mandos_clients = dbus.Dictionary()
586
607
        
587
608
        (self.mandos_serv
599
620
                            self.client_not_found,
600
621
                            dbus_interface=server_interface,
601
622
                            byte_arrays=True))
602
 
        for path, client in mandos_clients.items():
 
623
        for path, client in mandos_clients.iteritems():
603
624
            client_proxy_object = self.bus.get_object(self.busname,
604
625
                                                      path)
605
626
            self.add_client(MandosClientWidget(server_proxy_object
614
635
                                               logger
615
636
                                               =self.log_message),
616
637
                            path=path)
617
 
        
 
638
 
618
639
        self.refresh()
619
640
        self._input_callback_tag = (gobject.io_add_watch
620
641
                                    (sys.stdin.fileno(),
717
738
    ui.run()
718
739
except KeyboardInterrupt:
719
740
    ui.screen.stop()
720
 
except Exception as e:
721
 
    ui.log_message(str(e))
 
741
except Exception, e:
 
742
    ui.log_message(unicode(e))
722
743
    ui.screen.stop()
723
744
    raise