/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: 2015-06-28 16:35:27 UTC
  • mto: (237.7.307 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

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