/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: Teddy Hogeborn
  • Date: 2012-11-14 21:03:24 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 303.
  • Revision ID: teddy@recompile.se-20121114210324-n7m7k0ki2ncmje3a
* mandos-ctl (string_to_delta): Try to parse RFC 3339 duration before
                                anything else.  This also minimizes
                                the changes from the last release.
  (PGPEngine): Use straight subprocess.Popen() to call "gpg".
* mandos-monitor (UserInterface.run): Fix grammar.

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-2015 Teddy Hogeborn
7
 
# Copyright © 2009-2015 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
25
25
 
26
26
from __future__ import (division, absolute_import, print_function,
27
27
                        unicode_literals)
28
 
try:
29
 
    from future_builtins import *
30
 
except ImportError:
31
 
    pass
 
28
 
 
29
from future_builtins import *
32
30
 
33
31
import sys
34
32
import os
 
33
import signal
35
34
 
36
35
import datetime
37
36
 
39
38
import urwid
40
39
 
41
40
from dbus.mainloop.glib import DBusGMainLoop
42
 
try:
43
 
    import gobject
44
 
except ImportError:
45
 
    from gi.repository import GObject as gobject
 
41
import gobject
46
42
 
47
43
import dbus
48
44
 
 
45
import UserList
 
46
 
49
47
import locale
50
48
 
51
 
if sys.version_info.major == 2:
52
 
    str = unicode
53
 
 
54
49
locale.setlocale(locale.LC_ALL, '')
55
50
 
56
51
import logging
60
55
domain = 'se.recompile'
61
56
server_interface = domain + '.Mandos'
62
57
client_interface = domain + '.Mandos.Client'
63
 
version = "1.6.9"
 
58
version = "1.6.0"
 
59
 
 
60
# Always run in monochrome mode
 
61
urwid.curses_display.curses.has_colors = lambda : False
 
62
 
 
63
# Urwid doesn't support blinking, but we want it.  Since we have no
 
64
# use for underline on its own, we make underline also always blink.
 
65
urwid.curses_display.curses.A_UNDERLINE |= (
 
66
    urwid.curses_display.curses.A_BLINK)
64
67
 
65
68
def isoformat_to_datetime(iso):
66
69
    "Parse an ISO 8601 date string to a datetime.datetime()"
87
90
        self.proxy = proxy_object # Mandos Client proxy object
88
91
        self.properties = dict() if properties is None else properties
89
92
        self.property_changed_match = (
90
 
            self.proxy.connect_to_signal("PropertiesChanged",
91
 
                                         self.properties_changed,
92
 
                                         dbus.PROPERTIES_IFACE,
 
93
            self.proxy.connect_to_signal("PropertyChanged",
 
94
                                         self._property_changed,
 
95
                                         client_interface,
93
96
                                         byte_arrays=True))
94
97
        
95
98
        if properties is None:
100
103
        
101
104
        super(MandosClientPropertyCache, self).__init__(**kwargs)
102
105
    
103
 
    def properties_changed(self, interface, properties, invalidated):
104
 
        """This is called whenever we get a PropertiesChanged signal
105
 
        It updates the changed properties in the "properties" dict.
 
106
    def _property_changed(self, property, value):
 
107
        """Helper which takes positional arguments"""
 
108
        return self.property_changed(property=property, value=value)
 
109
    
 
110
    def property_changed(self, property=None, value=None):
 
111
        """This is called whenever we get a PropertyChanged signal
 
112
        It updates the changed property in the "properties" dict.
106
113
        """
107
114
        # Update properties dict with new value
108
 
        self.properties.update(properties)
 
115
        self.properties[property] = value
109
116
    
110
117
    def delete(self):
111
118
        self.property_changed_match.remove()
157
164
                                         self.rejected,
158
165
                                         client_interface,
159
166
                                         byte_arrays=True))
160
 
        self.logger('Created client {}'
161
 
                    .format(self.properties["Name"]), level=0)
 
167
        #self.logger('Created client {0}'
 
168
        #            .format(self.properties["Name"]))
162
169
    
163
170
    def using_timer(self, flag):
164
171
        """Call this method with True or False when timer should be
173
180
            gobject.source_remove(self._update_timer_callback_tag)
174
181
            self._update_timer_callback_tag = None
175
182
    
176
 
    def checker_completed(self, exitstatus, signal, command):
 
183
    def checker_completed(self, exitstatus, condition, command):
177
184
        if exitstatus == 0:
178
 
            self.logger('Checker for client {} (command "{}")'
179
 
                        ' succeeded'.format(self.properties["Name"],
180
 
                                            command), level=0)
181
185
            self.update()
182
186
            return
183
187
        # Checker failed
184
 
        if exitstatus >= 0:
185
 
            self.logger('Checker for client {} (command "{}") failed'
186
 
                        ' with exit code {}'
187
 
                        .format(self.properties["Name"], command,
188
 
                                exitstatus))
189
 
        elif signal != 0:
190
 
            self.logger('Checker for client {} (command "{}") was'
191
 
                        ' killed by signal {}'
192
 
                        .format(self.properties["Name"], command,
193
 
                                signal))
 
188
        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)))
 
193
        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)))
 
198
        elif os.WCOREDUMP(condition):
 
199
            self.logger('Checker for client {0} (command "{1}")'
 
200
                        ' dumped core'
 
201
                        .format(self.properties["Name"], command))
194
202
        else:
195
 
            self.logger('Checker for client {} completed'
 
203
            self.logger('Checker for client {0} completed'
196
204
                        ' mysteriously'
197
205
                        .format(self.properties["Name"]))
198
206
        self.update()
199
207
    
200
208
    def checker_started(self, command):
201
 
        """Server signals that a checker started."""
202
 
        self.logger('Client {} started checker "{}"'
203
 
                    .format(self.properties["Name"],
204
 
                            command), level=0)
 
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)))
 
214
        pass
205
215
    
206
216
    def got_secret(self):
207
 
        self.logger('Client {} received its secret'
 
217
        self.logger('Client {0} received its secret'
208
218
                    .format(self.properties["Name"]))
209
219
    
210
220
    def need_approval(self, timeout, default):
211
221
        if not default:
212
 
            message = 'Client {} needs approval within {} seconds'
 
222
            message = 'Client {0} needs approval within {1} seconds'
213
223
        else:
214
 
            message = 'Client {} will get its secret in {} seconds'
 
224
            message = 'Client {0} will get its secret in {1} seconds'
215
225
        self.logger(message.format(self.properties["Name"],
216
226
                                   timeout/1000))
217
227
    
218
228
    def rejected(self, reason):
219
 
        self.logger('Client {} was rejected; reason: {}'
 
229
        self.logger('Client {0} was rejected; reason: {1}'
220
230
                    .format(self.properties["Name"], reason))
221
231
    
222
232
    def selectable(self):
266
276
            else:
267
277
                timer = datetime.timedelta()
268
278
            if self.properties["ApprovedByDefault"]:
269
 
                message = "Approval in {}. (d)eny?"
 
279
                message = "Approval in {0}. (d)eny?"
270
280
            else:
271
 
                message = "Denial in {}. (a)pprove?"
272
 
            message = message.format(str(timer).rsplit(".", 1)[0])
 
281
                message = "Denial in {0}. (a)pprove?"
 
282
            message = message.format(unicode(timer).rsplit(".", 1)[0])
273
283
            self.using_timer(True)
274
284
        elif self.properties["LastCheckerStatus"] != 0:
275
285
            # When checker has failed, show timer until client expires
282
292
                timer = max(expires - datetime.datetime.utcnow(),
283
293
                            datetime.timedelta())
284
294
            message = ('A checker has failed! Time until client'
285
 
                       ' gets disabled: {}'
286
 
                       .format(str(timer).rsplit(".", 1)[0]))
 
295
                       ' gets disabled: {0}'
 
296
                       .format(unicode(timer).rsplit(".", 1)[0]))
287
297
            self.using_timer(True)
288
298
        else:
289
299
            message = "enabled"
290
300
            self.using_timer(False)
291
 
        self._text = "{}{}".format(base, message)
 
301
        self._text = "{0}{1}".format(base, message)
292
302
        
293
303
        if not urwid.supports_unicode():
294
304
            self._text = self._text.encode("ascii", "replace")
369
379
        else:
370
380
            return key
371
381
    
372
 
    def properties_changed(self, interface, properties, invalidated):
373
 
        """Call self.update() if any properties changed.
 
382
    def property_changed(self, property=None, **kwargs):
 
383
        """Call self.update() if old value is not new value.
374
384
        This overrides the method from MandosClientPropertyCache"""
375
 
        old_values = { key: self.properties.get(key)
376
 
                       for key in properties.keys() }
377
 
        super(MandosClientWidget, self).properties_changed(
378
 
            interface, properties, invalidated)
379
 
        if any(old_values[key] != self.properties.get(key)
380
 
               for key in old_values):
 
385
        property_name = unicode(property)
 
386
        old_value = self.properties.get(property_name)
 
387
        super(MandosClientWidget, self).property_changed(
 
388
            property=property, **kwargs)
 
389
        if self.properties.get(property_name) != old_value:
381
390
            self.update()
382
391
 
383
392
 
397
406
    """This is the entire user interface - the whole screen
398
407
    with boxes, lists of client widgets, etc.
399
408
    """
400
 
    def __init__(self, max_log_length=1000, log_level=1):
 
409
    def __init__(self, max_log_length=1000):
401
410
        DBusGMainLoop(set_as_default=True)
402
411
        
403
412
        self.screen = urwid.curses_display.Screen()
406
415
                ("normal",
407
416
                 "default", "default", None),
408
417
                ("bold",
409
 
                 "bold", "default", "bold"),
 
418
                 "default", "default", "bold"),
410
419
                ("underline-blink",
411
 
                 "underline,blink", "default", "underline,blink"),
 
420
                 "default", "default", "underline"),
412
421
                ("standout",
413
 
                 "standout", "default", "standout"),
 
422
                 "default", "default", "standout"),
414
423
                ("bold-underline-blink",
415
 
                 "bold,underline,blink", "default", "bold,underline,blink"),
 
424
                 "default", "default", ("bold", "underline")),
416
425
                ("bold-standout",
417
 
                 "bold,standout", "default", "bold,standout"),
 
426
                 "default", "default", ("bold", "standout")),
418
427
                ("underline-blink-standout",
419
 
                 "underline,blink,standout", "default",
420
 
                 "underline,blink,standout"),
 
428
                 "default", "default", ("underline", "standout")),
421
429
                ("bold-underline-blink-standout",
422
 
                 "bold,underline,blink,standout", "default",
423
 
                 "bold,underline,blink,standout"),
 
430
                 "default", "default", ("bold", "underline",
 
431
                                          "standout")),
424
432
                ))
425
433
        
426
434
        if urwid.supports_unicode():
441
449
        self.log = []
442
450
        self.max_log_length = max_log_length
443
451
        
444
 
        self.log_level = log_level
445
 
        
446
452
        # We keep a reference to the log widget so we can remove it
447
453
        # from the ListWalker without it getting destroyed
448
454
        self.logbox = ConstrainedListBox(self.log)
462
468
        self.main_loop = gobject.MainLoop()
463
469
    
464
470
    def client_not_found(self, fingerprint, address):
465
 
        self.log_message("Client with address {} and fingerprint {}"
466
 
                         " could not be found"
 
471
        self.log_message("Client with address {0} and fingerprint"
 
472
                         " {1} could not be found"
467
473
                         .format(address, fingerprint))
468
474
    
469
475
    def rebuild(self):
482
488
            self.uilist.append(self.logbox)
483
489
        self.topwidget = urwid.Pile(self.uilist)
484
490
    
485
 
    def log_message(self, message, level=1):
 
491
    def log_message(self, message):
486
492
        """Log message formatted with timestamp"""
487
 
        if level < self.log_level:
488
 
            return
489
493
        timestamp = datetime.datetime.now().isoformat()
490
 
        self.log_message_raw("{}: {}".format(timestamp, message),
491
 
                             level=level)
 
494
        self.log_message_raw(timestamp + ": " + message)
492
495
    
493
 
    def log_message_raw(self, markup, level=1):
 
496
    def log_message_raw(self, markup):
494
497
        """Add a log message to the log buffer."""
495
 
        if level < self.log_level:
496
 
            return
497
498
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
498
499
        if (self.max_log_length
499
500
            and len(self.log) > self.max_log_length):
506
507
        """Toggle visibility of the log buffer."""
507
508
        self.log_visible = not self.log_visible
508
509
        self.rebuild()
509
 
        self.log_message("Log visibility changed to: {}"
510
 
                         .format(self.log_visible), level=0)
 
510
        #self.log_message("Log visibility changed to: "
 
511
        #                 + unicode(self.log_visible))
511
512
    
512
513
    def change_log_display(self):
513
514
        """Change type of log display.
518
519
            self.log_wrap = "clip"
519
520
        for textwidget in self.log:
520
521
            textwidget.set_wrap_mode(self.log_wrap)
521
 
        self.log_message("Wrap mode: {}".format(self.log_wrap),
522
 
                         level=0)
 
522
        #self.log_message("Wrap mode: " + self.log_wrap)
523
523
    
524
524
    def find_and_remove_client(self, path, name):
525
525
        """Find a client by its object path and remove it.
530
530
            client = self.clients_dict[path]
531
531
        except KeyError:
532
532
            # not found?
533
 
            self.log_message("Unknown client {!r} ({!r}) removed"
 
533
            self.log_message("Unknown client {0!r} ({1!r}) removed"
534
534
                             .format(name, path))
535
535
            return
536
536
        client.delete()
554
554
        if path is None:
555
555
            path = client.proxy.object_path
556
556
        self.clients_dict[path] = client
557
 
        self.clients.sort(key=lambda c: c.properties["Name"])
 
557
        self.clients.sort(None, lambda c: c.properties["Name"])
558
558
        self.refresh()
559
559
    
560
560
    def remove_client(self, client, path=None):
562
562
        if path is None:
563
563
            path = client.proxy.object_path
564
564
        del self.clients_dict[path]
 
565
        if not self.clients_dict:
 
566
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
 
567
            # is completely emptied, we need to recreate it.
 
568
            self.clients = urwid.SimpleListWalker([])
 
569
            self.rebuild()
565
570
        self.refresh()
566
571
    
567
572
    def refresh(self):
601
606
                            self.client_not_found,
602
607
                            dbus_interface=server_interface,
603
608
                            byte_arrays=True))
604
 
        for path, client in mandos_clients.items():
 
609
        for path, client in mandos_clients.iteritems():
605
610
            client_proxy_object = self.bus.get_object(self.busname,
606
611
                                                      path)
607
612
            self.add_client(MandosClientWidget(server_proxy_object
654
659
            elif key == "window resize":
655
660
                self.size = self.screen.get_cols_rows()
656
661
                self.refresh()
657
 
            elif key == "ctrl l":
658
 
                self.screen.clear()
 
662
            elif key == "\f":  # Ctrl-L
659
663
                self.refresh()
660
664
            elif key == "l" or key == "D":
661
665
                self.toggle_log_display()
673
677
                                            "?: Help",
674
678
                                            "l: Log window toggle",
675
679
                                            "TAB: Switch window",
676
 
                                            "w: Wrap (log lines)",
677
 
                                            "v: Toggle verbose log",
678
 
                                            ))))
 
680
                                            "w: Wrap (log)"))))
679
681
                self.log_message_raw(("bold",
680
682
                                      "  "
681
683
                                      .join(("Clients:",
694
696
                else:
695
697
                    self.topwidget.set_focus(self.logbox)
696
698
                self.refresh()
697
 
            elif key == "v":
698
 
                if self.log_level == 0:
699
 
                    self.log_level = 1
700
 
                    self.log_message("Verbose mode: Off")
701
 
                else:
702
 
                    self.log_level = 0
703
 
                    self.log_message("Verbose mode: On")
704
699
            #elif (key == "end" or key == "meta >" or key == "G"
705
700
            #      or key == ">"):
706
701
            #    pass            # xxx end-of-buffer
729
724
    ui.run()
730
725
except KeyboardInterrupt:
731
726
    ui.screen.stop()
732
 
except Exception as e:
733
 
    ui.log_message(str(e))
 
727
except Exception, e:
 
728
    ui.log_message(unicode(e))
734
729
    ui.screen.stop()
735
730
    raise