/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: 2014-07-17 03:24:57 UTC
  • mto: This revision was merged to the branch mainline in revision 720.
  • Revision ID: teddy@recompile.se-20140717032457-7074pobx7ft1oiio
Tags: version-1.6.7-1
* Makefile (version): Changed to "1.6.7".
* NEWS (Version 1.6.7): New entry.
* debian/changelog (1.6.7-1): - '' -

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-2014 Teddy Hogeborn
 
7
# Copyright © 2009-2014 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
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)
 
28
try:
 
29
    from future_builtins import *
 
30
except ImportError:
 
31
    pass
27
32
 
28
33
import sys
29
34
import os
30
 
import signal
31
35
 
32
36
import datetime
33
37
 
35
39
import urwid
36
40
 
37
41
from dbus.mainloop.glib import DBusGMainLoop
38
 
import gobject
 
42
try:
 
43
    import gobject
 
44
except ImportError:
 
45
    from gi.repository import GObject as gobject
39
46
 
40
47
import dbus
41
48
 
42
 
import UserList
43
 
 
44
49
import locale
45
50
 
 
51
if sys.version_info[0] == 2:
 
52
    str = unicode
 
53
 
46
54
locale.setlocale(locale.LC_ALL, '')
47
55
 
48
56
import logging
52
60
domain = 'se.recompile'
53
61
server_interface = domain + '.Mandos'
54
62
client_interface = domain + '.Mandos.Client'
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)
 
63
version = "1.6.7"
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, *args, **kwargs):
 
86
    def __init__(self, proxy_object=None, properties=None, **kwargs):
87
87
        self.proxy = proxy_object # Mandos Client proxy object
88
 
        
89
 
        self.properties = dict()
 
88
        self.properties = dict() if properties is None else properties
90
89
        self.property_changed_match = (
91
90
            self.proxy.connect_to_signal("PropertyChanged",
92
 
                                         self.property_changed,
 
91
                                         self._property_changed,
93
92
                                         client_interface,
94
93
                                         byte_arrays=True))
95
94
        
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)
 
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)
103
106
    
104
107
    def property_changed(self, property=None, value=None):
105
108
        """This is called whenever we get a PropertyChanged signal
108
111
        # Update properties dict with new value
109
112
        self.properties[property] = value
110
113
    
111
 
    def delete(self, *args, **kwargs):
 
114
    def delete(self):
112
115
        self.property_changed_match.remove()
113
 
        super(MandosClientPropertyCache, self).__init__(
114
 
            *args, **kwargs)
115
116
 
116
117
 
117
118
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
119
120
    """
120
121
    
121
122
    def __init__(self, server_proxy_object=None, update_hook=None,
122
 
                 delete_hook=None, logger=None, *args, **kwargs):
 
123
                 delete_hook=None, logger=None, **kwargs):
123
124
        # Called on update
124
125
        self.update_hook = update_hook
125
126
        # Called on delete
130
131
        self.logger = logger
131
132
        
132
133
        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__(
140
 
            update_hook=update_hook, delete_hook=delete_hook,
141
 
            *args, **kwargs)
 
139
        super(MandosClientWidget, self).__init__(**kwargs)
142
140
        self.update()
143
141
        self.opened = False
144
142
        
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
 
        
154
143
        self.match_objects = (
155
144
            self.proxy.connect_to_signal("CheckerCompleted",
156
145
                                         self.checker_completed,
172
161
                                         self.rejected,
173
162
                                         client_interface,
174
163
                                         byte_arrays=True))
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))
 
164
        self.logger('Created client {0}'
 
165
                    .format(self.properties["Name"]), level=0)
187
166
    
188
167
    def using_timer(self, flag):
189
168
        """Call this method with True or False when timer should be
190
169
        activated or deactivated.
191
170
        """
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:
 
171
        if flag and self._update_timer_callback_tag is None:
198
172
            # Will update the shown timer value every second
199
173
            self._update_timer_callback_tag = (gobject.timeout_add
200
174
                                               (1000,
201
175
                                                self.update_timer))
202
 
        elif old and self._update_timer_callback_lock == 0:
 
176
        elif not (flag or self._update_timer_callback_tag is None):
203
177
            gobject.source_remove(self._update_timer_callback_tag)
204
178
            self._update_timer_callback_tag = None
205
179
    
206
180
    def checker_completed(self, exitstatus, condition, command):
207
181
        if exitstatus == 0:
 
182
            self.logger('Checker for client {0} (command "{1}")'
 
183
                        ' succeeded'.format(self.properties["Name"],
 
184
                                            command), level=0)
208
185
            self.update()
209
186
            return
210
187
        # Checker failed
211
188
        if os.WIFEXITED(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)))
 
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
193
        elif os.WIFSIGNALED(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)))
 
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
198
        elif os.WCOREDUMP(condition):
222
 
            self.logger('Checker for client %s (command "%s")'
 
199
            self.logger('Checker for client {0} (command "{1}")'
223
200
                        ' dumped core'
224
 
                        % (self.properties["Name"], command))
 
201
                        .format(self.properties["Name"], command))
225
202
        else:
226
 
            self.logger('Checker for client %s completed'
227
 
                        ' mysteriously')
 
203
            self.logger('Checker for client {0} completed'
 
204
                        ' mysteriously'
 
205
                        .format(self.properties["Name"]))
228
206
        self.update()
229
207
    
230
208
    def checker_started(self, command):
231
 
        """Server signals that a checker started. This could be useful
232
 
           to log in the future. """
233
 
        #self.logger('Client %s started checker "%s"'
234
 
        #            % (self.properties["Name"], unicode(command)))
235
 
        pass
 
209
        """Server signals that a checker started."""
 
210
        self.logger('Client {0} started checker "{1}"'
 
211
                    .format(self.properties["Name"],
 
212
                            command), level=0)
236
213
    
237
214
    def got_secret(self):
238
 
        self.logger('Client %s received its secret'
239
 
                    % self.properties["Name"])
 
215
        self.logger('Client {0} received its secret'
 
216
                    .format(self.properties["Name"]))
240
217
    
241
218
    def need_approval(self, timeout, default):
242
219
        if not default:
243
 
            message = 'Client %s needs approval within %s seconds'
 
220
            message = 'Client {0} needs approval within {1} seconds'
244
221
        else:
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)
 
222
            message = 'Client {0} will get its secret in {1} seconds'
 
223
        self.logger(message.format(self.properties["Name"],
 
224
                                   timeout/1000))
249
225
    
250
226
    def rejected(self, reason):
251
 
        self.logger('Client %s was rejected; reason: %s'
252
 
                    % (self.properties["Name"], reason))
 
227
        self.logger('Client {0} was rejected; reason: {1}'
 
228
                    .format(self.properties["Name"], reason))
253
229
    
254
230
    def selectable(self):
255
231
        """Make this a "selectable" widget.
277
253
                          "bold-underline-blink":
278
254
                              "bold-underline-blink-standout",
279
255
                          }
280
 
 
 
256
        
281
257
        # Rebuild focus and non-focus widgets using current properties
282
 
 
 
258
        
283
259
        # Base part of a client. Name!
284
 
        base = ('%(name)s: '
285
 
                      % {"name": self.properties["Name"]})
 
260
        base = '{name}: '.format(name=self.properties["Name"])
286
261
        if not self.properties["Enabled"]:
287
262
            message = "DISABLED"
 
263
            self.using_timer(False)
288
264
        elif self.properties["ApprovalPending"]:
289
265
            timeout = datetime.timedelta(milliseconds
290
266
                                         = self.properties
292
268
            last_approval_request = isoformat_to_datetime(
293
269
                self.properties["LastApprovalRequest"])
294
270
            if last_approval_request is not None:
295
 
                timer = timeout - (datetime.datetime.utcnow()
296
 
                                   - last_approval_request)
 
271
                timer = max(timeout - (datetime.datetime.utcnow()
 
272
                                       - last_approval_request),
 
273
                            datetime.timedelta())
297
274
            else:
298
275
                timer = datetime.timedelta()
299
276
            if self.properties["ApprovedByDefault"]:
300
 
                message = "Approval in %s. (d)eny?"
 
277
                message = "Approval in {0}. (d)eny?"
301
278
            else:
302
 
                message = "Denial in %s. (a)pprove?"
303
 
            message = message % unicode(timer).rsplit(".", 1)[0]
 
279
                message = "Denial in {0}. (a)pprove?"
 
280
            message = message.format(str(timer).rsplit(".", 1)[0])
 
281
            self.using_timer(True)
304
282
        elif self.properties["LastCheckerStatus"] != 0:
305
 
            # When checker has failed, print a timer until client expires
 
283
            # When checker has failed, show timer until client expires
306
284
            expires = self.properties["Expires"]
307
285
            if expires == "":
308
286
                timer = datetime.timedelta(0)
309
287
            else:
310
 
                expires = datetime.datetime.strptime(expires,
311
 
                                                     '%Y-%m-%dT%H:%M:%S.%f')
312
 
                timer = expires - datetime.datetime.utcnow()
 
288
                expires = (datetime.datetime.strptime
 
289
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
 
290
                timer = max(expires - datetime.datetime.utcnow(),
 
291
                            datetime.timedelta())
313
292
            message = ('A checker has failed! Time until client'
314
 
                       ' gets disabled: %s'
315
 
                           % unicode(timer).rsplit(".", 1)[0])
 
293
                       ' gets disabled: {0}'
 
294
                       .format(str(timer).rsplit(".", 1)[0]))
 
295
            self.using_timer(True)
316
296
        else:
317
297
            message = "enabled"
318
 
        self._text = "%s%s" % (base, message)
319
 
            
 
298
            self.using_timer(False)
 
299
        self._text = "{0}{1}".format(base, message)
 
300
        
320
301
        if not urwid.supports_unicode():
321
302
            self._text = self._text.encode("ascii", "replace")
322
303
        textlist = [("normal", self._text)]
339
320
        self.update()
340
321
        return True             # Keep calling this
341
322
    
342
 
    def delete(self, *args, **kwargs):
 
323
    def delete(self, **kwargs):
343
324
        if self._update_timer_callback_tag is not None:
344
325
            gobject.source_remove(self._update_timer_callback_tag)
345
326
            self._update_timer_callback_tag = None
348
329
        self.match_objects = ()
349
330
        if self.delete_hook is not None:
350
331
            self.delete_hook(self)
351
 
        return super(MandosClientWidget, self).delete(*args, **kwargs)
 
332
        return super(MandosClientWidget, self).delete(**kwargs)
352
333
    
353
334
    def render(self, maxcolrow, focus=False):
354
335
        """Render differently if we have focus.
396
377
        else:
397
378
            return key
398
379
    
399
 
    def property_changed(self, property=None, value=None,
400
 
                         *args, **kwargs):
 
380
    def property_changed(self, property=None, **kwargs):
401
381
        """Call self.update() if old value is not new value.
402
382
        This overrides the method from MandosClientPropertyCache"""
403
 
        property_name = unicode(property)
 
383
        property_name = str(property)
404
384
        old_value = self.properties.get(property_name)
405
385
        super(MandosClientWidget, self).property_changed(
406
 
            property=property, value=value, *args, **kwargs)
 
386
            property=property, **kwargs)
407
387
        if self.properties.get(property_name) != old_value:
408
388
            self.update()
409
389
 
413
393
    "down" key presses, thus not allowing any containing widgets to
414
394
    use them as an excuse to shift focus away from this widget.
415
395
    """
416
 
    def keypress(self, maxcolrow, key):
417
 
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
 
396
    def keypress(self, *args, **kwargs):
 
397
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
418
398
        if ret in ("up", "down"):
419
399
            return
420
400
        return ret
424
404
    """This is the entire user interface - the whole screen
425
405
    with boxes, lists of client widgets, etc.
426
406
    """
427
 
    def __init__(self, max_log_length=1000):
 
407
    def __init__(self, max_log_length=1000, log_level=1):
428
408
        DBusGMainLoop(set_as_default=True)
429
409
        
430
410
        self.screen = urwid.curses_display.Screen()
433
413
                ("normal",
434
414
                 "default", "default", None),
435
415
                ("bold",
436
 
                 "default", "default", "bold"),
 
416
                 "bold", "default", "bold"),
437
417
                ("underline-blink",
438
 
                 "default", "default", "underline"),
 
418
                 "underline,blink", "default", "underline,blink"),
439
419
                ("standout",
440
 
                 "default", "default", "standout"),
 
420
                 "standout", "default", "standout"),
441
421
                ("bold-underline-blink",
442
 
                 "default", "default", ("bold", "underline")),
 
422
                 "bold,underline,blink", "default", "bold,underline,blink"),
443
423
                ("bold-standout",
444
 
                 "default", "default", ("bold", "standout")),
 
424
                 "bold,standout", "default", "bold,standout"),
445
425
                ("underline-blink-standout",
446
 
                 "default", "default", ("underline", "standout")),
 
426
                 "underline,blink,standout", "default",
 
427
                 "underline,blink,standout"),
447
428
                ("bold-underline-blink-standout",
448
 
                 "default", "default", ("bold", "underline",
449
 
                                          "standout")),
 
429
                 "bold,underline,blink,standout", "default",
 
430
                 "bold,underline,blink,standout"),
450
431
                ))
451
432
        
452
433
        if urwid.supports_unicode():
467
448
        self.log = []
468
449
        self.max_log_length = max_log_length
469
450
        
 
451
        self.log_level = log_level
 
452
        
470
453
        # We keep a reference to the log widget so we can remove it
471
454
        # from the ListWalker without it getting destroyed
472
455
        self.logbox = ConstrainedListBox(self.log)
486
469
        self.main_loop = gobject.MainLoop()
487
470
    
488
471
    def client_not_found(self, fingerprint, address):
489
 
        self.log_message(("Client with address %s and fingerprint %s"
490
 
                          " could not be found" % (address,
491
 
                                                    fingerprint)))
 
472
        self.log_message("Client with address {0} and fingerprint"
 
473
                         " {1} could not be found"
 
474
                         .format(address, fingerprint))
492
475
    
493
476
    def rebuild(self):
494
477
        """This rebuilds the User Interface.
506
489
            self.uilist.append(self.logbox)
507
490
        self.topwidget = urwid.Pile(self.uilist)
508
491
    
509
 
    def log_message(self, message):
 
492
    def log_message(self, message, level=1):
 
493
        """Log message formatted with timestamp"""
 
494
        if level < self.log_level:
 
495
            return
510
496
        timestamp = datetime.datetime.now().isoformat()
511
 
        self.log_message_raw(timestamp + ": " + message)
 
497
        self.log_message_raw("{0}: {1}".format(timestamp, message),
 
498
                             level=level)
512
499
    
513
 
    def log_message_raw(self, markup):
 
500
    def log_message_raw(self, markup, level=1):
514
501
        """Add a log message to the log buffer."""
 
502
        if level < self.log_level:
 
503
            return
515
504
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
516
505
        if (self.max_log_length
517
506
            and len(self.log) > self.max_log_length):
524
513
        """Toggle visibility of the log buffer."""
525
514
        self.log_visible = not self.log_visible
526
515
        self.rebuild()
527
 
        #self.log_message("Log visibility changed to: "
528
 
        #                 + unicode(self.log_visible))
 
516
        self.log_message("Log visibility changed to: {0}"
 
517
                         .format(self.log_visible), level=0)
529
518
    
530
519
    def change_log_display(self):
531
520
        """Change type of log display.
536
525
            self.log_wrap = "clip"
537
526
        for textwidget in self.log:
538
527
            textwidget.set_wrap_mode(self.log_wrap)
539
 
        #self.log_message("Wrap mode: " + self.log_wrap)
 
528
        self.log_message("Wrap mode: {0}".format(self.log_wrap),
 
529
                         level=0)
540
530
    
541
531
    def find_and_remove_client(self, path, name):
542
532
        """Find a client by its object path and remove it.
547
537
            client = self.clients_dict[path]
548
538
        except KeyError:
549
539
            # not found?
550
 
            self.log_message("Unknown client %r (%r) removed", name,
551
 
                             path)
 
540
            self.log_message("Unknown client {0!r} ({1!r}) removed"
 
541
                             .format(name, path))
552
542
            return
553
543
        client.delete()
554
544
    
571
561
        if path is None:
572
562
            path = client.proxy.object_path
573
563
        self.clients_dict[path] = client
574
 
        self.clients.sort(None, lambda c: c.properties["Name"])
 
564
        self.clients.sort(key=lambda c: c.properties["Name"])
575
565
        self.refresh()
576
566
    
577
567
    def remove_client(self, client, path=None):
579
569
        if path is None:
580
570
            path = client.proxy.object_path
581
571
        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()
587
572
        self.refresh()
588
573
    
589
574
    def refresh(self):
602
587
        try:
603
588
            mandos_clients = (self.mandos_serv
604
589
                              .GetAllClientsWithProperties())
 
590
            if not mandos_clients:
 
591
                self.log_message_raw(("bold", "Note: Server has no clients."))
605
592
        except dbus.exceptions.DBusException:
 
593
            self.log_message_raw(("bold", "Note: No Mandos server running."))
606
594
            mandos_clients = dbus.Dictionary()
607
595
        
608
596
        (self.mandos_serv
620
608
                            self.client_not_found,
621
609
                            dbus_interface=server_interface,
622
610
                            byte_arrays=True))
623
 
        for path, client in mandos_clients.iteritems():
 
611
        for path, client in mandos_clients.items():
624
612
            client_proxy_object = self.bus.get_object(self.busname,
625
613
                                                      path)
626
614
            self.add_client(MandosClientWidget(server_proxy_object
635
623
                                               logger
636
624
                                               =self.log_message),
637
625
                            path=path)
638
 
 
 
626
        
639
627
        self.refresh()
640
628
        self._input_callback_tag = (gobject.io_add_watch
641
629
                                    (sys.stdin.fileno(),
691
679
                                            "?: Help",
692
680
                                            "l: Log window toggle",
693
681
                                            "TAB: Switch window",
694
 
                                            "w: Wrap (log)"))))
 
682
                                            "w: Wrap (log lines)",
 
683
                                            "v: Toggle verbose log",
 
684
                                            ))))
695
685
                self.log_message_raw(("bold",
696
686
                                      "  "
697
687
                                      .join(("Clients:",
710
700
                else:
711
701
                    self.topwidget.set_focus(self.logbox)
712
702
                self.refresh()
 
703
            elif key == "v":
 
704
                if self.log_level == 0:
 
705
                    self.log_level = 1
 
706
                    self.log_message("Verbose mode: Off")
 
707
                else:
 
708
                    self.log_level = 0
 
709
                    self.log_message("Verbose mode: On")
713
710
            #elif (key == "end" or key == "meta >" or key == "G"
714
711
            #      or key == ">"):
715
712
            #    pass            # xxx end-of-buffer
738
735
    ui.run()
739
736
except KeyboardInterrupt:
740
737
    ui.screen.stop()
741
 
except Exception, e:
742
 
    ui.log_message(unicode(e))
 
738
except Exception as e:
 
739
    ui.log_message(str(e))
743
740
    ui.screen.stop()
744
741
    raise