/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: 2016-03-07 20:31:27 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 337.
  • Revision ID: teddy@recompile.se-20160307203127-dn9nyl6a5e2a6l4g
Remove empty comment

* mandos: Remove empty comment.

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-2016 Teddy Hogeborn
 
7
# Copyright © 2009-2016 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
    from gi.repository import GObject
 
44
except ImportError:
 
45
    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.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)
 
63
version = "1.7.4"
 
64
 
 
65
try:
 
66
    dbus.OBJECT_MANAGER_IFACE
 
67
except AttributeError:
 
68
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
67
69
 
68
70
def isoformat_to_datetime(iso):
69
71
    "Parse an ISO 8601 date string to a datetime.datetime()"
90
92
        self.proxy = proxy_object # Mandos Client proxy object
91
93
        self.properties = dict() if properties is None else properties
92
94
        self.property_changed_match = (
93
 
            self.proxy.connect_to_signal("PropertyChanged",
94
 
                                         self._property_changed,
95
 
                                         client_interface,
 
95
            self.proxy.connect_to_signal("PropertiesChanged",
 
96
                                         self.properties_changed,
 
97
                                         dbus.PROPERTIES_IFACE,
96
98
                                         byte_arrays=True))
97
99
        
98
100
        if properties is None:
103
105
        
104
106
        super(MandosClientPropertyCache, self).__init__(**kwargs)
105
107
    
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.
 
108
    def properties_changed(self, interface, properties, invalidated):
 
109
        """This is called whenever we get a PropertiesChanged signal
 
110
        It updates the changed properties in the "properties" dict.
113
111
        """
114
112
        # Update properties dict with new value
115
 
        self.properties[property] = value
 
113
        if interface == client_interface:
 
114
            self.properties.update(properties)
116
115
    
117
116
    def delete(self):
118
117
        self.property_changed_match.remove()
164
163
                                         self.rejected,
165
164
                                         client_interface,
166
165
                                         byte_arrays=True))
167
 
        #self.logger('Created client {0}'
168
 
        #            .format(self.properties["Name"]))
 
166
        self.logger('Created client {}'
 
167
                    .format(self.properties["Name"]), level=0)
169
168
    
170
169
    def using_timer(self, flag):
171
170
        """Call this method with True or False when timer should be
173
172
        """
174
173
        if flag and self._update_timer_callback_tag is None:
175
174
            # Will update the shown timer value every second
176
 
            self._update_timer_callback_tag = (gobject.timeout_add
 
175
            self._update_timer_callback_tag = (GObject.timeout_add
177
176
                                               (1000,
178
177
                                                self.update_timer))
179
178
        elif not (flag or self._update_timer_callback_tag is None):
180
 
            gobject.source_remove(self._update_timer_callback_tag)
 
179
            GObject.source_remove(self._update_timer_callback_tag)
181
180
            self._update_timer_callback_tag = None
182
181
    
183
182
    def checker_completed(self, exitstatus, condition, command):
184
183
        if exitstatus == 0:
 
184
            self.logger('Checker for client {} (command "{}")'
 
185
                        ' succeeded'.format(self.properties["Name"],
 
186
                                            command), level=0)
185
187
            self.update()
186
188
            return
187
189
        # Checker failed
188
190
        if os.WIFEXITED(condition):
189
 
            self.logger('Checker for client {0} (command "{1}")'
190
 
                        ' failed with exit code {2}'
 
191
            self.logger('Checker for client {} (command "{}") failed'
 
192
                        ' with exit code {}'
191
193
                        .format(self.properties["Name"], command,
192
194
                                os.WEXITSTATUS(condition)))
193
195
        elif os.WIFSIGNALED(condition):
194
 
            self.logger('Checker for client {0} (command "{1}") was'
195
 
                        ' killed by signal {2}'
 
196
            self.logger('Checker for client {} (command "{}") was'
 
197
                        ' killed by signal {}'
196
198
                        .format(self.properties["Name"], command,
197
199
                                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))
202
 
        else:
203
 
            self.logger('Checker for client {0} completed'
204
 
                        ' mysteriously'
205
 
                        .format(self.properties["Name"]))
206
200
        self.update()
207
201
    
208
202
    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
 
203
        """Server signals that a checker started."""
 
204
        self.logger('Client {} started checker "{}"'
 
205
                    .format(self.properties["Name"],
 
206
                            command), level=0)
215
207
    
216
208
    def got_secret(self):
217
 
        self.logger('Client {0} received its secret'
 
209
        self.logger('Client {} received its secret'
218
210
                    .format(self.properties["Name"]))
219
211
    
220
212
    def need_approval(self, timeout, default):
221
213
        if not default:
222
 
            message = 'Client {0} needs approval within {1} seconds'
 
214
            message = 'Client {} needs approval within {} seconds'
223
215
        else:
224
 
            message = 'Client {0} will get its secret in {1} seconds'
 
216
            message = 'Client {} will get its secret in {} seconds'
225
217
        self.logger(message.format(self.properties["Name"],
226
218
                                   timeout/1000))
227
219
    
228
220
    def rejected(self, reason):
229
 
        self.logger('Client {0} was rejected; reason: {1}'
 
221
        self.logger('Client {} was rejected; reason: {}'
230
222
                    .format(self.properties["Name"], reason))
231
223
    
232
224
    def selectable(self):
276
268
            else:
277
269
                timer = datetime.timedelta()
278
270
            if self.properties["ApprovedByDefault"]:
279
 
                message = "Approval in {0}. (d)eny?"
 
271
                message = "Approval in {}. (d)eny?"
280
272
            else:
281
 
                message = "Denial in {0}. (a)pprove?"
282
 
            message = message.format(unicode(timer).rsplit(".", 1)[0])
 
273
                message = "Denial in {}. (a)pprove?"
 
274
            message = message.format(str(timer).rsplit(".", 1)[0])
283
275
            self.using_timer(True)
284
276
        elif self.properties["LastCheckerStatus"] != 0:
285
277
            # When checker has failed, show timer until client expires
292
284
                timer = max(expires - datetime.datetime.utcnow(),
293
285
                            datetime.timedelta())
294
286
            message = ('A checker has failed! Time until client'
295
 
                       ' gets disabled: {0}'
296
 
                       .format(unicode(timer).rsplit(".", 1)[0]))
 
287
                       ' gets disabled: {}'
 
288
                       .format(str(timer).rsplit(".", 1)[0]))
297
289
            self.using_timer(True)
298
290
        else:
299
291
            message = "enabled"
300
292
            self.using_timer(False)
301
 
        self._text = "{0}{1}".format(base, message)
 
293
        self._text = "{}{}".format(base, message)
302
294
        
303
295
        if not urwid.supports_unicode():
304
296
            self._text = self._text.encode("ascii", "replace")
317
309
            self.update_hook()
318
310
    
319
311
    def update_timer(self):
320
 
        """called by gobject. Will indefinitely loop until
321
 
        gobject.source_remove() on tag is called"""
 
312
        """called by GObject. Will indefinitely loop until
 
313
        GObject.source_remove() on tag is called"""
322
314
        self.update()
323
315
        return True             # Keep calling this
324
316
    
325
317
    def delete(self, **kwargs):
326
318
        if self._update_timer_callback_tag is not None:
327
 
            gobject.source_remove(self._update_timer_callback_tag)
 
319
            GObject.source_remove(self._update_timer_callback_tag)
328
320
            self._update_timer_callback_tag = None
329
321
        for match in self.match_objects:
330
322
            match.remove()
343
335
        """Handle keys.
344
336
        This overrides the method from urwid.FlowWidget"""
345
337
        if key == "+":
346
 
            self.proxy.Enable(dbus_interface = client_interface,
347
 
                              ignore_reply=True)
 
338
            self.proxy.Set(client_interface, "Enabled",
 
339
                           dbus.Boolean(True), ignore_reply = True,
 
340
                           dbus_interface = dbus.PROPERTIES_IFACE)
348
341
        elif key == "-":
349
 
            self.proxy.Disable(dbus_interface = client_interface,
350
 
                               ignore_reply=True)
 
342
            self.proxy.Set(client_interface, "Enabled", False,
 
343
                           ignore_reply = True,
 
344
                           dbus_interface = dbus.PROPERTIES_IFACE)
351
345
        elif key == "a":
352
346
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
353
347
                               dbus_interface = client_interface,
361
355
                                                  .object_path,
362
356
                                                  ignore_reply=True)
363
357
        elif key == "s":
364
 
            self.proxy.StartChecker(dbus_interface = client_interface,
365
 
                                    ignore_reply=True)
 
358
            self.proxy.Set(client_interface, "CheckerRunning",
 
359
                           dbus.Boolean(True), ignore_reply = True,
 
360
                           dbus_interface = dbus.PROPERTIES_IFACE)
366
361
        elif key == "S":
367
 
            self.proxy.StopChecker(dbus_interface = client_interface,
368
 
                                   ignore_reply=True)
 
362
            self.proxy.Set(client_interface, "CheckerRunning",
 
363
                           dbus.Boolean(False), ignore_reply = True,
 
364
                           dbus_interface = dbus.PROPERTIES_IFACE)
369
365
        elif key == "C":
370
366
            self.proxy.CheckedOK(dbus_interface = client_interface,
371
367
                                 ignore_reply=True)
379
375
        else:
380
376
            return key
381
377
    
382
 
    def property_changed(self, property=None, **kwargs):
383
 
        """Call self.update() if old value is not new value.
 
378
    def properties_changed(self, interface, properties, invalidated):
 
379
        """Call self.update() if any properties changed.
384
380
        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:
 
381
        old_values = { key: self.properties.get(key)
 
382
                       for key in properties.keys() }
 
383
        super(MandosClientWidget, self).properties_changed(
 
384
            interface, properties, invalidated)
 
385
        if any(old_values[key] != self.properties.get(key)
 
386
               for key in old_values):
390
387
            self.update()
391
388
 
392
389
 
406
403
    """This is the entire user interface - the whole screen
407
404
    with boxes, lists of client widgets, etc.
408
405
    """
409
 
    def __init__(self, max_log_length=1000):
 
406
    def __init__(self, max_log_length=1000, log_level=1):
410
407
        DBusGMainLoop(set_as_default=True)
411
408
        
412
409
        self.screen = urwid.curses_display.Screen()
415
412
                ("normal",
416
413
                 "default", "default", None),
417
414
                ("bold",
418
 
                 "default", "default", "bold"),
 
415
                 "bold", "default", "bold"),
419
416
                ("underline-blink",
420
 
                 "default", "default", "underline"),
 
417
                 "underline,blink", "default", "underline,blink"),
421
418
                ("standout",
422
 
                 "default", "default", "standout"),
 
419
                 "standout", "default", "standout"),
423
420
                ("bold-underline-blink",
424
 
                 "default", "default", ("bold", "underline")),
 
421
                 "bold,underline,blink", "default", "bold,underline,blink"),
425
422
                ("bold-standout",
426
 
                 "default", "default", ("bold", "standout")),
 
423
                 "bold,standout", "default", "bold,standout"),
427
424
                ("underline-blink-standout",
428
 
                 "default", "default", ("underline", "standout")),
 
425
                 "underline,blink,standout", "default",
 
426
                 "underline,blink,standout"),
429
427
                ("bold-underline-blink-standout",
430
 
                 "default", "default", ("bold", "underline",
431
 
                                          "standout")),
 
428
                 "bold,underline,blink,standout", "default",
 
429
                 "bold,underline,blink,standout"),
432
430
                ))
433
431
        
434
432
        if urwid.supports_unicode():
449
447
        self.log = []
450
448
        self.max_log_length = max_log_length
451
449
        
 
450
        self.log_level = log_level
 
451
        
452
452
        # We keep a reference to the log widget so we can remove it
453
453
        # from the ListWalker without it getting destroyed
454
454
        self.logbox = ConstrainedListBox(self.log)
465
465
                              "q: Quit  ?: Help"))
466
466
        
467
467
        self.busname = domain + '.Mandos'
468
 
        self.main_loop = gobject.MainLoop()
 
468
        self.main_loop = GObject.MainLoop()
469
469
    
470
470
    def client_not_found(self, fingerprint, address):
471
 
        self.log_message("Client with address {0} and fingerprint"
472
 
                         " {1} could not be found"
 
471
        self.log_message("Client with address {} and fingerprint {}"
 
472
                         " could not be found"
473
473
                         .format(address, fingerprint))
474
474
    
475
475
    def rebuild(self):
488
488
            self.uilist.append(self.logbox)
489
489
        self.topwidget = urwid.Pile(self.uilist)
490
490
    
491
 
    def log_message(self, message):
 
491
    def log_message(self, message, level=1):
492
492
        """Log message formatted with timestamp"""
 
493
        if level < self.log_level:
 
494
            return
493
495
        timestamp = datetime.datetime.now().isoformat()
494
 
        self.log_message_raw(timestamp + ": " + message)
 
496
        self.log_message_raw("{}: {}".format(timestamp, message),
 
497
                             level=level)
495
498
    
496
 
    def log_message_raw(self, markup):
 
499
    def log_message_raw(self, markup, level=1):
497
500
        """Add a log message to the log buffer."""
 
501
        if level < self.log_level:
 
502
            return
498
503
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
499
504
        if (self.max_log_length
500
505
            and len(self.log) > self.max_log_length):
507
512
        """Toggle visibility of the log buffer."""
508
513
        self.log_visible = not self.log_visible
509
514
        self.rebuild()
510
 
        #self.log_message("Log visibility changed to: "
511
 
        #                 + unicode(self.log_visible))
 
515
        self.log_message("Log visibility changed to: {}"
 
516
                         .format(self.log_visible), level=0)
512
517
    
513
518
    def change_log_display(self):
514
519
        """Change type of log display.
519
524
            self.log_wrap = "clip"
520
525
        for textwidget in self.log:
521
526
            textwidget.set_wrap_mode(self.log_wrap)
522
 
        #self.log_message("Wrap mode: " + self.log_wrap)
 
527
        self.log_message("Wrap mode: {}".format(self.log_wrap),
 
528
                         level=0)
523
529
    
524
 
    def find_and_remove_client(self, path, name):
 
530
    def find_and_remove_client(self, path, interfaces):
525
531
        """Find a client by its object path and remove it.
526
532
        
527
 
        This is connected to the ClientRemoved signal from the
 
533
        This is connected to the InterfacesRemoved signal from the
528
534
        Mandos server object."""
 
535
        if client_interface not in interfaces:
 
536
            # Not a Mandos client object; ignore
 
537
            return
529
538
        try:
530
539
            client = self.clients_dict[path]
531
540
        except KeyError:
532
541
            # not found?
533
 
            self.log_message("Unknown client {0!r} ({1!r}) removed"
534
 
                             .format(name, path))
 
542
            self.log_message("Unknown client {!r} removed"
 
543
                             .format(path))
535
544
            return
536
545
        client.delete()
537
546
    
538
 
    def add_new_client(self, path):
 
547
    def add_new_client(self, path, ifs_and_props):
 
548
        """Find a client by its object path and remove it.
 
549
        
 
550
        This is connected to the InterfacesAdded signal from the
 
551
        Mandos server object.
 
552
        """
 
553
        if client_interface not in ifs_and_props:
 
554
            # Not a Mandos client object; ignore
 
555
            return
539
556
        client_proxy_object = self.bus.get_object(self.busname, path)
540
557
        self.add_client(MandosClientWidget(server_proxy_object
541
558
                                           =self.mandos_serv,
546
563
                                           delete_hook
547
564
                                           =self.remove_client,
548
565
                                           logger
549
 
                                           =self.log_message),
 
566
                                           =self.log_message,
 
567
                                           properties
 
568
                                           = dict(ifs_and_props[
 
569
                                               client_interface])),
550
570
                        path=path)
551
571
    
552
572
    def add_client(self, client, path=None):
554
574
        if path is None:
555
575
            path = client.proxy.object_path
556
576
        self.clients_dict[path] = client
557
 
        self.clients.sort(None, lambda c: c.properties["Name"])
 
577
        self.clients.sort(key=lambda c: c.properties["Name"])
558
578
        self.refresh()
559
579
    
560
580
    def remove_client(self, client, path=None):
562
582
        if path is None:
563
583
            path = client.proxy.object_path
564
584
        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()
570
585
        self.refresh()
571
586
    
572
587
    def refresh(self):
588
603
            if not mandos_clients:
589
604
                self.log_message_raw(("bold", "Note: Server has no clients."))
590
605
        except dbus.exceptions.DBusException:
591
 
            self.log_message_raw(("bold", "Note: No Mandos servers running."))
 
606
            self.log_message_raw(("bold", "Note: No Mandos server running."))
592
607
            mandos_clients = dbus.Dictionary()
593
608
        
594
609
        (self.mandos_serv
595
 
         .connect_to_signal("ClientRemoved",
 
610
         .connect_to_signal("InterfacesRemoved",
596
611
                            self.find_and_remove_client,
597
 
                            dbus_interface=server_interface,
 
612
                            dbus_interface
 
613
                            = dbus.OBJECT_MANAGER_IFACE,
598
614
                            byte_arrays=True))
599
615
        (self.mandos_serv
600
 
         .connect_to_signal("ClientAdded",
 
616
         .connect_to_signal("InterfacesAdded",
601
617
                            self.add_new_client,
602
 
                            dbus_interface=server_interface,
 
618
                            dbus_interface
 
619
                            = dbus.OBJECT_MANAGER_IFACE,
603
620
                            byte_arrays=True))
604
621
        (self.mandos_serv
605
622
         .connect_to_signal("ClientNotFound",
606
623
                            self.client_not_found,
607
624
                            dbus_interface=server_interface,
608
625
                            byte_arrays=True))
609
 
        for path, client in mandos_clients.iteritems():
 
626
        for path, client in mandos_clients.items():
610
627
            client_proxy_object = self.bus.get_object(self.busname,
611
628
                                                      path)
612
629
            self.add_client(MandosClientWidget(server_proxy_object
623
640
                            path=path)
624
641
        
625
642
        self.refresh()
626
 
        self._input_callback_tag = (gobject.io_add_watch
 
643
        self._input_callback_tag = (GObject.io_add_watch
627
644
                                    (sys.stdin.fileno(),
628
 
                                     gobject.IO_IN,
 
645
                                     GObject.IO_IN,
629
646
                                     self.process_input))
630
647
        self.main_loop.run()
631
648
        # Main loop has finished, we should close everything now
632
 
        gobject.source_remove(self._input_callback_tag)
 
649
        GObject.source_remove(self._input_callback_tag)
633
650
        self.screen.stop()
634
651
    
635
652
    def stop(self):
659
676
            elif key == "window resize":
660
677
                self.size = self.screen.get_cols_rows()
661
678
                self.refresh()
662
 
            elif key == "\f":  # Ctrl-L
 
679
            elif key == "ctrl l":
 
680
                self.screen.clear()
663
681
                self.refresh()
664
682
            elif key == "l" or key == "D":
665
683
                self.toggle_log_display()
677
695
                                            "?: Help",
678
696
                                            "l: Log window toggle",
679
697
                                            "TAB: Switch window",
680
 
                                            "w: Wrap (log)"))))
 
698
                                            "w: Wrap (log lines)",
 
699
                                            "v: Toggle verbose log",
 
700
                                            ))))
681
701
                self.log_message_raw(("bold",
682
702
                                      "  "
683
703
                                      .join(("Clients:",
696
716
                else:
697
717
                    self.topwidget.set_focus(self.logbox)
698
718
                self.refresh()
 
719
            elif key == "v":
 
720
                if self.log_level == 0:
 
721
                    self.log_level = 1
 
722
                    self.log_message("Verbose mode: Off")
 
723
                else:
 
724
                    self.log_level = 0
 
725
                    self.log_message("Verbose mode: On")
699
726
            #elif (key == "end" or key == "meta >" or key == "G"
700
727
            #      or key == ">"):
701
728
            #    pass            # xxx end-of-buffer
724
751
    ui.run()
725
752
except KeyboardInterrupt:
726
753
    ui.screen.stop()
727
 
except Exception, e:
728
 
    ui.log_message(unicode(e))
 
754
except Exception as e:
 
755
    ui.log_message(str(e))
729
756
    ui.screen.stop()
730
757
    raise