/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-05-26 22:21:17 UTC
  • mto: This revision was merged to the branch mainline in revision 591.
  • Revision ID: teddy@recompile.se-20120526222117-2n4oeb3hqyq4rjdh
* mandos: Implement "--socket" option.
  (IPv6_TCPServer.__init__): Take new "socketfd" parameter; use it.
  (MandosServer.__init__): Take new "socketfd" parameter.  Pass it on
                           to IPv6_TCPServer constructor.
  (main): Take new "--socket" option.  Also take "socket" parameter in
          "mandos.conf" configuration file.  If set, pass the value to
          MandosServer constructor.
* mandos-options.xml (socket): Document new "socket" option.
* mandos-conf.xml (OPTIONS): - '' -
* mandos.xml (SYNOPSIS, OPTIONS): Document new "--socket" 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-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
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.8"
 
58
version = "1.5.4"
 
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()"
161
164
                                         self.rejected,
162
165
                                         client_interface,
163
166
                                         byte_arrays=True))
164
 
        self.logger('Created client {}'
165
 
                    .format(self.properties["Name"]), level=0)
 
167
        #self.logger('Created client {0}'
 
168
        #            .format(self.properties["Name"]))
166
169
    
167
170
    def using_timer(self, flag):
168
171
        """Call this method with True or False when timer should be
179
182
    
180
183
    def checker_completed(self, exitstatus, condition, command):
181
184
        if exitstatus == 0:
182
 
            self.logger('Checker for client {} (command "{}")'
183
 
                        ' succeeded'.format(self.properties["Name"],
184
 
                                            command), level=0)
185
185
            self.update()
186
186
            return
187
187
        # Checker failed
188
188
        if os.WIFEXITED(condition):
189
 
            self.logger('Checker for client {} (command "{}") failed'
190
 
                        ' with exit code {}'
 
189
            self.logger('Checker for client {0} (command "{1}")'
 
190
                        ' failed with exit code {2}'
191
191
                        .format(self.properties["Name"], command,
192
192
                                os.WEXITSTATUS(condition)))
193
193
        elif os.WIFSIGNALED(condition):
194
 
            self.logger('Checker for client {} (command "{}") was'
195
 
                        ' killed by signal {}'
 
194
            self.logger('Checker for client {0} (command "{1}") was'
 
195
                        ' killed by signal {2}'
196
196
                        .format(self.properties["Name"], command,
197
197
                                os.WTERMSIG(condition)))
198
198
        elif os.WCOREDUMP(condition):
199
 
            self.logger('Checker for client {} (command "{}") dumped'
200
 
                        ' core'.format(self.properties["Name"],
201
 
                                       command))
 
199
            self.logger('Checker for client {0} (command "{1}")'
 
200
                        ' dumped core'
 
201
                        .format(self.properties["Name"], command))
202
202
        else:
203
 
            self.logger('Checker for client {} completed'
 
203
            self.logger('Checker for client {0} completed'
204
204
                        ' mysteriously'
205
205
                        .format(self.properties["Name"]))
206
206
        self.update()
207
207
    
208
208
    def checker_started(self, command):
209
 
        """Server signals that a checker started."""
210
 
        self.logger('Client {} started checker "{}"'
211
 
                    .format(self.properties["Name"],
212
 
                            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
213
215
    
214
216
    def got_secret(self):
215
 
        self.logger('Client {} received its secret'
 
217
        self.logger('Client {0} received its secret'
216
218
                    .format(self.properties["Name"]))
217
219
    
218
220
    def need_approval(self, timeout, default):
219
221
        if not default:
220
 
            message = 'Client {} needs approval within {} seconds'
 
222
            message = 'Client {0} needs approval within {1} seconds'
221
223
        else:
222
 
            message = 'Client {} will get its secret in {} seconds'
 
224
            message = 'Client {0} will get its secret in {1} seconds'
223
225
        self.logger(message.format(self.properties["Name"],
224
226
                                   timeout/1000))
225
227
    
226
228
    def rejected(self, reason):
227
 
        self.logger('Client {} was rejected; reason: {}'
 
229
        self.logger('Client {0} was rejected; reason: {1}'
228
230
                    .format(self.properties["Name"], reason))
229
231
    
230
232
    def selectable(self):
274
276
            else:
275
277
                timer = datetime.timedelta()
276
278
            if self.properties["ApprovedByDefault"]:
277
 
                message = "Approval in {}. (d)eny?"
 
279
                message = "Approval in {0}. (d)eny?"
278
280
            else:
279
 
                message = "Denial in {}. (a)pprove?"
280
 
            message = message.format(str(timer).rsplit(".", 1)[0])
 
281
                message = "Denial in {0}. (a)pprove?"
 
282
            message = message.format(unicode(timer).rsplit(".", 1)[0])
281
283
            self.using_timer(True)
282
284
        elif self.properties["LastCheckerStatus"] != 0:
283
285
            # When checker has failed, show timer until client expires
290
292
                timer = max(expires - datetime.datetime.utcnow(),
291
293
                            datetime.timedelta())
292
294
            message = ('A checker has failed! Time until client'
293
 
                       ' gets disabled: {}'
294
 
                       .format(str(timer).rsplit(".", 1)[0]))
 
295
                       ' gets disabled: {0}'
 
296
                       .format(unicode(timer).rsplit(".", 1)[0]))
295
297
            self.using_timer(True)
296
298
        else:
297
299
            message = "enabled"
298
300
            self.using_timer(False)
299
 
        self._text = "{}{}".format(base, message)
 
301
        self._text = "{0}{1}".format(base, message)
300
302
        
301
303
        if not urwid.supports_unicode():
302
304
            self._text = self._text.encode("ascii", "replace")
380
382
    def property_changed(self, property=None, **kwargs):
381
383
        """Call self.update() if old value is not new value.
382
384
        This overrides the method from MandosClientPropertyCache"""
383
 
        property_name = str(property)
 
385
        property_name = unicode(property)
384
386
        old_value = self.properties.get(property_name)
385
387
        super(MandosClientWidget, self).property_changed(
386
388
            property=property, **kwargs)
404
406
    """This is the entire user interface - the whole screen
405
407
    with boxes, lists of client widgets, etc.
406
408
    """
407
 
    def __init__(self, max_log_length=1000, log_level=1):
 
409
    def __init__(self, max_log_length=1000):
408
410
        DBusGMainLoop(set_as_default=True)
409
411
        
410
412
        self.screen = urwid.curses_display.Screen()
413
415
                ("normal",
414
416
                 "default", "default", None),
415
417
                ("bold",
416
 
                 "bold", "default", "bold"),
 
418
                 "default", "default", "bold"),
417
419
                ("underline-blink",
418
 
                 "underline,blink", "default", "underline,blink"),
 
420
                 "default", "default", "underline"),
419
421
                ("standout",
420
 
                 "standout", "default", "standout"),
 
422
                 "default", "default", "standout"),
421
423
                ("bold-underline-blink",
422
 
                 "bold,underline,blink", "default", "bold,underline,blink"),
 
424
                 "default", "default", ("bold", "underline")),
423
425
                ("bold-standout",
424
 
                 "bold,standout", "default", "bold,standout"),
 
426
                 "default", "default", ("bold", "standout")),
425
427
                ("underline-blink-standout",
426
 
                 "underline,blink,standout", "default",
427
 
                 "underline,blink,standout"),
 
428
                 "default", "default", ("underline", "standout")),
428
429
                ("bold-underline-blink-standout",
429
 
                 "bold,underline,blink,standout", "default",
430
 
                 "bold,underline,blink,standout"),
 
430
                 "default", "default", ("bold", "underline",
 
431
                                          "standout")),
431
432
                ))
432
433
        
433
434
        if urwid.supports_unicode():
448
449
        self.log = []
449
450
        self.max_log_length = max_log_length
450
451
        
451
 
        self.log_level = log_level
452
 
        
453
452
        # We keep a reference to the log widget so we can remove it
454
453
        # from the ListWalker without it getting destroyed
455
454
        self.logbox = ConstrainedListBox(self.log)
469
468
        self.main_loop = gobject.MainLoop()
470
469
    
471
470
    def client_not_found(self, fingerprint, address):
472
 
        self.log_message("Client with address {} and fingerprint {}"
473
 
                         " could not be found"
 
471
        self.log_message("Client with address {0} and fingerprint"
 
472
                         " {1} could not be found"
474
473
                         .format(address, fingerprint))
475
474
    
476
475
    def rebuild(self):
489
488
            self.uilist.append(self.logbox)
490
489
        self.topwidget = urwid.Pile(self.uilist)
491
490
    
492
 
    def log_message(self, message, level=1):
493
 
        """Log message formatted with timestamp"""
494
 
        if level < self.log_level:
495
 
            return
 
491
    def log_message(self, message):
496
492
        timestamp = datetime.datetime.now().isoformat()
497
 
        self.log_message_raw("{}: {}".format(timestamp, message),
498
 
                             level=level)
 
493
        self.log_message_raw(timestamp + ": " + message)
499
494
    
500
 
    def log_message_raw(self, markup, level=1):
 
495
    def log_message_raw(self, markup):
501
496
        """Add a log message to the log buffer."""
502
 
        if level < self.log_level:
503
 
            return
504
497
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
505
498
        if (self.max_log_length
506
499
            and len(self.log) > self.max_log_length):
513
506
        """Toggle visibility of the log buffer."""
514
507
        self.log_visible = not self.log_visible
515
508
        self.rebuild()
516
 
        self.log_message("Log visibility changed to: {}"
517
 
                         .format(self.log_visible), level=0)
 
509
        #self.log_message("Log visibility changed to: "
 
510
        #                 + unicode(self.log_visible))
518
511
    
519
512
    def change_log_display(self):
520
513
        """Change type of log display.
525
518
            self.log_wrap = "clip"
526
519
        for textwidget in self.log:
527
520
            textwidget.set_wrap_mode(self.log_wrap)
528
 
        self.log_message("Wrap mode: {}".format(self.log_wrap),
529
 
                         level=0)
 
521
        #self.log_message("Wrap mode: " + self.log_wrap)
530
522
    
531
523
    def find_and_remove_client(self, path, name):
532
524
        """Find a client by its object path and remove it.
537
529
            client = self.clients_dict[path]
538
530
        except KeyError:
539
531
            # not found?
540
 
            self.log_message("Unknown client {!r} ({!r}) removed"
 
532
            self.log_message("Unknown client {0!r} ({1!r}) removed"
541
533
                             .format(name, path))
542
534
            return
543
535
        client.delete()
561
553
        if path is None:
562
554
            path = client.proxy.object_path
563
555
        self.clients_dict[path] = client
564
 
        self.clients.sort(key=lambda c: c.properties["Name"])
 
556
        self.clients.sort(None, lambda c: c.properties["Name"])
565
557
        self.refresh()
566
558
    
567
559
    def remove_client(self, client, path=None):
569
561
        if path is None:
570
562
            path = client.proxy.object_path
571
563
        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()
572
569
        self.refresh()
573
570
    
574
571
    def refresh(self):
587
584
        try:
588
585
            mandos_clients = (self.mandos_serv
589
586
                              .GetAllClientsWithProperties())
590
 
            if not mandos_clients:
591
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
592
587
        except dbus.exceptions.DBusException:
593
 
            self.log_message_raw(("bold", "Note: No Mandos server running."))
594
588
            mandos_clients = dbus.Dictionary()
595
589
        
596
590
        (self.mandos_serv
608
602
                            self.client_not_found,
609
603
                            dbus_interface=server_interface,
610
604
                            byte_arrays=True))
611
 
        for path, client in mandos_clients.items():
 
605
        for path, client in mandos_clients.iteritems():
612
606
            client_proxy_object = self.bus.get_object(self.busname,
613
607
                                                      path)
614
608
            self.add_client(MandosClientWidget(server_proxy_object
661
655
            elif key == "window resize":
662
656
                self.size = self.screen.get_cols_rows()
663
657
                self.refresh()
664
 
            elif key == "ctrl l":
665
 
                self.screen.clear()
 
658
            elif key == "\f":  # Ctrl-L
666
659
                self.refresh()
667
660
            elif key == "l" or key == "D":
668
661
                self.toggle_log_display()
680
673
                                            "?: Help",
681
674
                                            "l: Log window toggle",
682
675
                                            "TAB: Switch window",
683
 
                                            "w: Wrap (log lines)",
684
 
                                            "v: Toggle verbose log",
685
 
                                            ))))
 
676
                                            "w: Wrap (log)"))))
686
677
                self.log_message_raw(("bold",
687
678
                                      "  "
688
679
                                      .join(("Clients:",
701
692
                else:
702
693
                    self.topwidget.set_focus(self.logbox)
703
694
                self.refresh()
704
 
            elif key == "v":
705
 
                if self.log_level == 0:
706
 
                    self.log_level = 1
707
 
                    self.log_message("Verbose mode: Off")
708
 
                else:
709
 
                    self.log_level = 0
710
 
                    self.log_message("Verbose mode: On")
711
695
            #elif (key == "end" or key == "meta >" or key == "G"
712
696
            #      or key == ">"):
713
697
            #    pass            # xxx end-of-buffer
736
720
    ui.run()
737
721
except KeyboardInterrupt:
738
722
    ui.screen.stop()
739
 
except Exception as e:
740
 
    ui.log_message(str(e))
 
723
except Exception, e:
 
724
    ui.log_message(unicode(e))
741
725
    ui.screen.stop()
742
726
    raise