/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: 2017-01-25 19:38:31 UTC
  • Revision ID: teddy@recompile.se-20170125193831-rz39tr8c5yg8yy7f
Tags: version-1.7.14-1
* Makefile (version): Change to 1.7.14.
* NEWS (Version 1.7.14): Add new entry.
* debian/changelog (1.7.14-1): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-monitor
1
 
#!/usr/bin/python3 -bbI
 
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
#
6
 
# Copyright © 2009-2019 Teddy Hogeborn
7
 
# Copyright © 2009-2019 Björn Påhlsson
8
 
#
9
 
# This file is part of Mandos.
10
 
#
11
 
# Mandos is free software: you can redistribute it and/or modify it
12
 
# under the terms of the GNU General Public License as published by
 
6
# Copyright © 2009-2016 Teddy Hogeborn
 
7
# Copyright © 2009-2016 Björn Påhlsson
 
8
#
 
9
# This program is free software: you can redistribute it and/or modify
 
10
# it under the terms of the GNU General Public License as published by
13
11
# the Free Software Foundation, either version 3 of the License, or
14
12
# (at your option) any later version.
15
13
#
16
 
#     Mandos is distributed in the hope that it will be useful, but
17
 
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
14
#     This program is distributed in the hope that it will be useful,
 
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
18
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19
17
#     GNU General Public License for more details.
20
18
#
21
19
# You should have received a copy of the GNU General Public License
22
 
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
23
22
#
24
23
# Contact the authors at <mandos@recompile.se>.
25
24
#
 
25
 
26
26
from __future__ import (division, absolute_import, print_function,
27
27
                        unicode_literals)
28
 
 
29
28
try:
30
29
    from future_builtins import *
31
30
except ImportError:
32
31
    pass
33
32
 
34
33
import sys
35
 
import logging
36
34
import os
37
 
import warnings
 
35
 
38
36
import datetime
39
 
import locale
40
37
 
41
38
import urwid.curses_display
42
39
import urwid
46
43
 
47
44
import dbus
48
45
 
 
46
import locale
 
47
 
 
48
import logging
 
49
 
49
50
if sys.version_info.major == 2:
50
 
    __metaclass__ = type
51
51
    str = unicode
52
 
    input = raw_input
53
 
 
54
 
# Show warnings by default
55
 
if not sys.warnoptions:
56
 
    warnings.simplefilter("default")
57
 
 
58
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
59
 
logging.basicConfig(level="NOTSET", # Show all messages
60
 
                    format="%(message)s") # Show basic log messages
61
 
 
62
 
logging.captureWarnings(True)   # Show warnings via the logging system
63
 
 
64
 
locale.setlocale(locale.LC_ALL, "")
65
 
 
66
 
logging.getLogger("dbus.proxies").setLevel(logging.CRITICAL)
 
52
 
 
53
locale.setlocale(locale.LC_ALL, '')
 
54
 
 
55
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
67
56
 
68
57
# Some useful constants
69
 
domain = "se.recompile"
70
 
server_interface = domain + ".Mandos"
71
 
client_interface = domain + ".Mandos.Client"
72
 
version = "1.8.14"
 
58
domain = 'se.recompile'
 
59
server_interface = domain + '.Mandos'
 
60
client_interface = domain + '.Mandos.Client'
 
61
version = "1.7.14"
73
62
 
74
63
try:
75
64
    dbus.OBJECT_MANAGER_IFACE
94
83
                             int(fraction*1000000))  # Microseconds
95
84
 
96
85
 
97
 
class MandosClientPropertyCache:
 
86
class MandosClientPropertyCache(object):
98
87
    """This wraps a Mandos Client D-Bus proxy object, caches the
99
88
    properties and calls a hook function when any of them are
100
89
    changed.
132
121
    """
133
122
 
134
123
    def __init__(self, server_proxy_object=None, update_hook=None,
135
 
                 delete_hook=None, **kwargs):
 
124
                 delete_hook=None, logger=None, **kwargs):
136
125
        # Called on update
137
126
        self.update_hook = update_hook
138
127
        # Called on delete
139
128
        self.delete_hook = delete_hook
140
129
        # Mandos Server proxy object
141
130
        self.server_proxy_object = server_proxy_object
 
131
        # Logger
 
132
        self.logger = logger
142
133
 
143
134
        self._update_timer_callback_tag = None
144
135
 
171
162
                                         self.rejected,
172
163
                                         client_interface,
173
164
                                         byte_arrays=True))
174
 
        log.debug("Created client %s", self.properties["Name"])
 
165
        self.logger('Created client {}'
 
166
                    .format(self.properties["Name"]), level=0)
175
167
 
176
168
    def using_timer(self, flag):
177
169
        """Call this method with True or False when timer should be
179
171
        """
180
172
        if flag and self._update_timer_callback_tag is None:
181
173
            # Will update the shown timer value every second
182
 
            self._update_timer_callback_tag = (
183
 
                GLib.timeout_add(1000,
184
 
                                 glib_safely(self.update_timer)))
 
174
            self._update_timer_callback_tag = (GLib.timeout_add
 
175
                                               (1000,
 
176
                                                self.update_timer))
185
177
        elif not (flag or self._update_timer_callback_tag is None):
186
178
            GLib.source_remove(self._update_timer_callback_tag)
187
179
            self._update_timer_callback_tag = None
188
180
 
189
181
    def checker_completed(self, exitstatus, condition, command):
190
182
        if exitstatus == 0:
191
 
            log.debug('Checker for client %s (command "%s")'
192
 
                      " succeeded", self.properties["Name"], command)
 
183
            self.logger('Checker for client {} (command "{}")'
 
184
                        ' succeeded'.format(self.properties["Name"],
 
185
                                            command), level=0)
193
186
            self.update()
194
187
            return
195
188
        # Checker failed
196
189
        if os.WIFEXITED(condition):
197
 
            log.info('Checker for client %s (command "%s") failed'
198
 
                     " with exit code %d", self.properties["Name"],
199
 
                     command, os.WEXITSTATUS(condition))
 
190
            self.logger('Checker for client {} (command "{}") failed'
 
191
                        ' with exit code {}'
 
192
                        .format(self.properties["Name"], command,
 
193
                                os.WEXITSTATUS(condition)))
200
194
        elif os.WIFSIGNALED(condition):
201
 
            log.info('Checker for client %s (command "%s") was'
202
 
                     " killed by signal %d", self.properties["Name"],
203
 
                     command, os.WTERMSIG(condition))
 
195
            self.logger('Checker for client {} (command "{}") was'
 
196
                        ' killed by signal {}'
 
197
                        .format(self.properties["Name"], command,
 
198
                                os.WTERMSIG(condition)))
204
199
        self.update()
205
200
 
206
201
    def checker_started(self, command):
207
202
        """Server signals that a checker started."""
208
 
        log.debug('Client %s started checker "%s"',
209
 
                  self.properties["Name"], command)
 
203
        self.logger('Client {} started checker "{}"'
 
204
                    .format(self.properties["Name"],
 
205
                            command), level=0)
210
206
 
211
207
    def got_secret(self):
212
 
        log.info("Client %s received its secret",
213
 
                 self.properties["Name"])
 
208
        self.logger('Client {} received its secret'
 
209
                    .format(self.properties["Name"]))
214
210
 
215
211
    def need_approval(self, timeout, default):
216
212
        if not default:
217
 
            message = "Client %s needs approval within %f seconds"
 
213
            message = 'Client {} needs approval within {} seconds'
218
214
        else:
219
 
            message = "Client %s will get its secret in %f seconds"
220
 
        log.info(message, self.properties["Name"], timeout/1000)
 
215
            message = 'Client {} will get its secret in {} seconds'
 
216
        self.logger(message.format(self.properties["Name"],
 
217
                                   timeout/1000))
221
218
 
222
219
    def rejected(self, reason):
223
 
        log.info("Client %s was rejected; reason: %s",
224
 
                 self.properties["Name"], reason)
 
220
        self.logger('Client {} was rejected; reason: {}'
 
221
                    .format(self.properties["Name"], reason))
225
222
 
226
223
    def selectable(self):
227
224
        """Make this a "selectable" widget.
253
250
        # Rebuild focus and non-focus widgets using current properties
254
251
 
255
252
        # Base part of a client. Name!
256
 
        base = "{name}: ".format(name=self.properties["Name"])
 
253
        base = '{name}: '.format(name=self.properties["Name"])
257
254
        if not self.properties["Enabled"]:
258
255
            message = "DISABLED"
259
256
            self.using_timer(False)
281
278
                timer = datetime.timedelta(0)
282
279
            else:
283
280
                expires = (datetime.datetime.strptime
284
 
                           (expires, "%Y-%m-%dT%H:%M:%S.%f"))
 
281
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
285
282
                timer = max(expires - datetime.datetime.utcnow(),
286
283
                            datetime.timedelta())
287
 
            message = ("A checker has failed! Time until client"
288
 
                       " gets disabled: {}"
 
284
            message = ('A checker has failed! Time until client'
 
285
                       ' gets disabled: {}'
289
286
                       .format(str(timer).rsplit(".", 1)[0]))
290
287
            self.using_timer(True)
291
288
        else:
389
386
            self.update()
390
387
 
391
388
 
392
 
def glib_safely(func, retval=True):
393
 
    def safe_func(*args, **kwargs):
394
 
        try:
395
 
            return func(*args, **kwargs)
396
 
        except Exception:
397
 
            log.exception("")
398
 
            return retval
399
 
    return safe_func
400
 
 
401
 
 
402
389
class ConstrainedListBox(urwid.ListBox):
403
390
    """Like a normal urwid.ListBox, but will consume all "up" or
404
391
    "down" key presses, thus not allowing any containing widgets to
412
399
        return ret
413
400
 
414
401
 
415
 
class UserInterface:
 
402
class UserInterface(object):
416
403
    """This is the entire user interface - the whole screen
417
404
    with boxes, lists of client widgets, etc.
418
405
    """
419
 
    def __init__(self, max_log_length=1000):
 
406
    def __init__(self, max_log_length=1000, log_level=1):
420
407
        DBusGMainLoop(set_as_default=True)
421
408
 
422
409
        self.screen = urwid.curses_display.Screen()
456
443
        self.clients_dict = {}
457
444
 
458
445
        # We will add Text widgets to this list
459
 
        self.log = urwid.SimpleListWalker([])
 
446
        self.log = []
460
447
        self.max_log_length = max_log_length
461
448
 
 
449
        self.log_level = log_level
 
450
 
462
451
        # We keep a reference to the log widget so we can remove it
463
452
        # from the ListWalker without it getting destroyed
464
453
        self.logbox = ConstrainedListBox(self.log)
468
457
        self.log_visible = True
469
458
        self.log_wrap = "any"
470
459
 
471
 
        self.loghandler = UILogHandler(self)
472
 
 
473
460
        self.rebuild()
474
 
        self.add_log_line(("bold",
475
 
                           "Mandos Monitor version " + version))
476
 
        self.add_log_line(("bold", "q: Quit  ?: Help"))
 
461
        self.log_message_raw(("bold",
 
462
                              "Mandos Monitor version " + version))
 
463
        self.log_message_raw(("bold",
 
464
                              "q: Quit  ?: Help"))
477
465
 
478
 
        self.busname = domain + ".Mandos"
 
466
        self.busname = domain + '.Mandos'
479
467
        self.main_loop = GLib.MainLoop()
480
468
 
481
 
    def client_not_found(self, key_id, address):
482
 
        log.info("Client with address %s and key ID %s could"
483
 
                 " not be found", address, key_id)
 
469
    def client_not_found(self, fingerprint, address):
 
470
        self.log_message("Client with address {} and fingerprint {}"
 
471
                         " could not be found"
 
472
                         .format(address, fingerprint))
484
473
 
485
474
    def rebuild(self):
486
475
        """This rebuilds the User Interface.
497
486
            self.uilist.append(self.logbox)
498
487
        self.topwidget = urwid.Pile(self.uilist)
499
488
 
500
 
    def add_log_line(self, markup):
 
489
    def log_message(self, message, level=1):
 
490
        """Log message formatted with timestamp"""
 
491
        if level < self.log_level:
 
492
            return
 
493
        timestamp = datetime.datetime.now().isoformat()
 
494
        self.log_message_raw("{}: {}".format(timestamp, message),
 
495
                             level=level)
 
496
 
 
497
    def log_message_raw(self, markup, level=1):
 
498
        """Add a log message to the log buffer."""
 
499
        if level < self.log_level:
 
500
            return
501
501
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
502
502
        if self.max_log_length:
503
503
            if len(self.log) > self.max_log_length:
504
 
                del self.log[0:(len(self.log) - self.max_log_length)]
505
 
        self.logbox.set_focus(len(self.logbox.body.contents)-1,
 
504
                del self.log[0:len(self.log)-self.max_log_length-1]
 
505
        self.logbox.set_focus(len(self.logbox.body.contents),
506
506
                              coming_from="above")
507
507
        self.refresh()
508
508
 
510
510
        """Toggle visibility of the log buffer."""
511
511
        self.log_visible = not self.log_visible
512
512
        self.rebuild()
513
 
        log.debug("Log visibility changed to: %s", self.log_visible)
 
513
        self.log_message("Log visibility changed to: {}"
 
514
                         .format(self.log_visible), level=0)
514
515
 
515
516
    def change_log_display(self):
516
517
        """Change type of log display.
521
522
            self.log_wrap = "clip"
522
523
        for textwidget in self.log:
523
524
            textwidget.set_wrap_mode(self.log_wrap)
524
 
        log.debug("Wrap mode: %s", self.log_wrap)
 
525
        self.log_message("Wrap mode: {}".format(self.log_wrap),
 
526
                         level=0)
525
527
 
526
528
    def find_and_remove_client(self, path, interfaces):
527
529
        """Find a client by its object path and remove it.
535
537
            client = self.clients_dict[path]
536
538
        except KeyError:
537
539
            # not found?
538
 
            log.warning("Unknown client %s removed", path)
 
540
            self.log_message("Unknown client {!r} removed"
 
541
                             .format(path))
539
542
            return
540
543
        client.delete()
541
544
 
554
557
            proxy_object=client_proxy_object,
555
558
            update_hook=self.refresh,
556
559
            delete_hook=self.remove_client,
 
560
            logger=self.log_message,
557
561
            properties=dict(ifs_and_props[client_interface])),
558
562
                        path=path)
559
563
 
579
583
 
580
584
    def run(self):
581
585
        """Start the main loop and exit when it's done."""
582
 
        log.addHandler(self.loghandler)
583
 
        self.orig_log_propagate = log.propagate
584
 
        log.propagate = False
585
 
        self.orig_log_level = log.level
586
 
        log.setLevel("INFO")
587
586
        self.bus = dbus.SystemBus()
588
587
        mandos_dbus_objc = self.bus.get_object(
589
588
            self.busname, "/", follow_name_owner_changes=True)
593
592
            mandos_clients = (self.mandos_serv
594
593
                              .GetAllClientsWithProperties())
595
594
            if not mandos_clients:
596
 
                log.warning("Note: Server has no clients.")
 
595
                self.log_message_raw(("bold",
 
596
                                      "Note: Server has no clients."))
597
597
        except dbus.exceptions.DBusException:
598
 
            log.warning("Note: No Mandos server running.")
 
598
            self.log_message_raw(("bold",
 
599
                                  "Note: No Mandos server running."))
599
600
            mandos_clients = dbus.Dictionary()
600
601
 
601
602
        (self.mandos_serv
621
622
                proxy_object=client_proxy_object,
622
623
                properties=client,
623
624
                update_hook=self.refresh,
624
 
                delete_hook=self.remove_client),
 
625
                delete_hook=self.remove_client,
 
626
                logger=self.log_message),
625
627
                            path=path)
626
628
 
627
629
        self.refresh()
628
 
        self._input_callback_tag = (
629
 
            GLib.io_add_watch(
630
 
                GLib.IOChannel.unix_new(sys.stdin.fileno()),
631
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
632
 
                glib_safely(self.process_input)))
 
630
        self._input_callback_tag = (GLib.io_add_watch
 
631
                                    (sys.stdin.fileno(),
 
632
                                     GLib.IO_IN,
 
633
                                     self.process_input))
633
634
        self.main_loop.run()
634
635
        # Main loop has finished, we should close everything now
635
636
        GLib.source_remove(self._input_callback_tag)
636
 
        with warnings.catch_warnings():
637
 
            warnings.simplefilter("ignore", BytesWarning)
638
 
            self.screen.stop()
 
637
        self.screen.stop()
639
638
 
640
639
    def stop(self):
641
640
        self.main_loop.quit()
642
 
        log.removeHandler(self.loghandler)
643
 
        log.propagate = self.orig_log_propagate
644
641
 
645
642
    def process_input(self, source, condition):
646
643
        keys = self.screen.get_input()
679
676
                if not self.log_visible:
680
677
                    self.log_visible = True
681
678
                    self.rebuild()
682
 
                self.add_log_line(("bold",
683
 
                                   "  ".join(("q: Quit",
684
 
                                              "?: Help",
685
 
                                              "l: Log window toggle",
686
 
                                              "TAB: Switch window",
687
 
                                              "w: Wrap (log lines)",
688
 
                                              "v: Toggle verbose log",
689
 
                                   ))))
690
 
                self.add_log_line(("bold",
691
 
                                   "  ".join(("Clients:",
692
 
                                              "+: Enable",
693
 
                                              "-: Disable",
694
 
                                              "R: Remove",
695
 
                                              "s: Start new checker",
696
 
                                              "S: Stop checker",
697
 
                                              "C: Checker OK",
698
 
                                              "a: Approve",
699
 
                                              "d: Deny",
700
 
                                   ))))
 
679
                self.log_message_raw(("bold",
 
680
                                      "  ".
 
681
                                      join(("q: Quit",
 
682
                                            "?: Help",
 
683
                                            "l: Log window toggle",
 
684
                                            "TAB: Switch window",
 
685
                                            "w: Wrap (log lines)",
 
686
                                            "v: Toggle verbose log",
 
687
                                            ))))
 
688
                self.log_message_raw(("bold",
 
689
                                      "  "
 
690
                                      .join(("Clients:",
 
691
                                             "+: Enable",
 
692
                                             "-: Disable",
 
693
                                             "R: Remove",
 
694
                                             "s: Start new checker",
 
695
                                             "S: Stop checker",
 
696
                                             "C: Checker OK",
 
697
                                             "a: Approve",
 
698
                                             "d: Deny"))))
701
699
                self.refresh()
702
700
            elif key == "tab":
703
701
                if self.topwidget.get_focus() is self.logbox:
706
704
                    self.topwidget.set_focus(self.logbox)
707
705
                self.refresh()
708
706
            elif key == "v":
709
 
                if log.level < logging.INFO:
710
 
                    log.setLevel(logging.INFO)
711
 
                    log.info("Verbose mode: Off")
 
707
                if self.log_level == 0:
 
708
                    self.log_level = 1
 
709
                    self.log_message("Verbose mode: Off")
712
710
                else:
713
 
                    log.setLevel(logging.NOTSET)
714
 
                    log.info("Verbose mode: On")
 
711
                    self.log_level = 0
 
712
                    self.log_message("Verbose mode: On")
715
713
            # elif (key == "end" or key == "meta >" or key == "G"
716
714
            #       or key == ">"):
717
715
            #     pass            # xxx end-of-buffer
736
734
        return True
737
735
 
738
736
 
739
 
class UILogHandler(logging.Handler):
740
 
    def __init__(self, ui, *args, **kwargs):
741
 
        self.ui = ui
742
 
        super(UILogHandler, self).__init__(*args, **kwargs)
743
 
        self.setFormatter(
744
 
            logging.Formatter("%(asctime)s: %(message)s"))
745
 
    def emit(self, record):
746
 
        msg = self.format(record)
747
 
        if record.levelno > logging.INFO:
748
 
            msg = ("bold", msg)
749
 
        self.ui.add_log_line(msg)
750
 
 
751
 
 
752
737
ui = UserInterface()
753
738
try:
754
739
    ui.run()
755
740
except KeyboardInterrupt:
756
 
    with warnings.catch_warnings():
757
 
        warnings.filterwarnings("ignore", "", BytesWarning)
758
 
        ui.screen.stop()
759
 
except Exception:
760
 
    with warnings.catch_warnings():
761
 
        warnings.filterwarnings("ignore", "", BytesWarning)
762
 
        ui.screen.stop()
 
741
    ui.screen.stop()
 
742
except Exception as e:
 
743
    ui.log_message(str(e))
 
744
    ui.screen.stop()
763
745
    raise