/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-06-23 19:49:21 UTC
  • mfrom: (237.7.408 trunk)
  • Revision ID: teddy@recompile.se-20160623194921-5bgaecm8us764lnb
Merge from trunk

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
from gi.repository import GLib
42
43
 
43
44
import dbus
44
45
 
45
 
import UserList
46
 
 
47
46
import locale
48
47
 
 
48
if sys.version_info.major == 2:
 
49
    str = unicode
 
50
 
49
51
locale.setlocale(locale.LC_ALL, '')
50
52
 
51
53
import logging
55
57
domain = 'se.recompile'
56
58
server_interface = domain + '.Mandos'
57
59
client_interface = domain + '.Mandos.Client'
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)
 
60
version = "1.7.9"
 
61
 
 
62
try:
 
63
    dbus.OBJECT_MANAGER_IFACE
 
64
except AttributeError:
 
65
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
67
66
 
68
67
def isoformat_to_datetime(iso):
69
68
    "Parse an ISO 8601 date string to a datetime.datetime()"
90
89
        self.proxy = proxy_object # Mandos Client proxy object
91
90
        self.properties = dict() if properties is None else properties
92
91
        self.property_changed_match = (
93
 
            self.proxy.connect_to_signal("PropertyChanged",
94
 
                                         self._property_changed,
95
 
                                         client_interface,
 
92
            self.proxy.connect_to_signal("PropertiesChanged",
 
93
                                         self.properties_changed,
 
94
                                         dbus.PROPERTIES_IFACE,
96
95
                                         byte_arrays=True))
97
96
        
98
97
        if properties is None:
103
102
        
104
103
        super(MandosClientPropertyCache, self).__init__(**kwargs)
105
104
    
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.
 
105
    def properties_changed(self, interface, properties, invalidated):
 
106
        """This is called whenever we get a PropertiesChanged signal
 
107
        It updates the changed properties in the "properties" dict.
113
108
        """
114
109
        # Update properties dict with new value
115
 
        self.properties[property] = value
 
110
        if interface == client_interface:
 
111
            self.properties.update(properties)
116
112
    
117
113
    def delete(self):
118
114
        self.property_changed_match.remove()
164
160
                                         self.rejected,
165
161
                                         client_interface,
166
162
                                         byte_arrays=True))
167
 
        #self.logger('Created client {0}'
168
 
        #            .format(self.properties["Name"]))
 
163
        self.logger('Created client {}'
 
164
                    .format(self.properties["Name"]), level=0)
169
165
    
170
166
    def using_timer(self, flag):
171
167
        """Call this method with True or False when timer should be
173
169
        """
174
170
        if flag and self._update_timer_callback_tag is None:
175
171
            # Will update the shown timer value every second
176
 
            self._update_timer_callback_tag = (gobject.timeout_add
 
172
            self._update_timer_callback_tag = (GLib.timeout_add
177
173
                                               (1000,
178
174
                                                self.update_timer))
179
175
        elif not (flag or self._update_timer_callback_tag is None):
180
 
            gobject.source_remove(self._update_timer_callback_tag)
 
176
            GLib.source_remove(self._update_timer_callback_tag)
181
177
            self._update_timer_callback_tag = None
182
178
    
183
179
    def checker_completed(self, exitstatus, condition, command):
184
180
        if exitstatus == 0:
 
181
            self.logger('Checker for client {} (command "{}")'
 
182
                        ' succeeded'.format(self.properties["Name"],
 
183
                                            command), level=0)
185
184
            self.update()
186
185
            return
187
186
        # Checker failed
188
187
        if os.WIFEXITED(condition):
189
 
            self.logger('Checker for client {0} (command "{1}")'
190
 
                        ' failed with exit code {2}'
 
188
            self.logger('Checker for client {} (command "{}") failed'
 
189
                        ' with exit code {}'
191
190
                        .format(self.properties["Name"], command,
192
191
                                os.WEXITSTATUS(condition)))
193
192
        elif os.WIFSIGNALED(condition):
194
 
            self.logger('Checker for client {0} (command "{1}") was'
195
 
                        ' killed by signal {2}'
 
193
            self.logger('Checker for client {} (command "{}") was'
 
194
                        ' killed by signal {}'
196
195
                        .format(self.properties["Name"], command,
197
196
                                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
197
        self.update()
207
198
    
208
199
    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
 
200
        """Server signals that a checker started."""
 
201
        self.logger('Client {} started checker "{}"'
 
202
                    .format(self.properties["Name"],
 
203
                            command), level=0)
215
204
    
216
205
    def got_secret(self):
217
 
        self.logger('Client {0} received its secret'
 
206
        self.logger('Client {} received its secret'
218
207
                    .format(self.properties["Name"]))
219
208
    
220
209
    def need_approval(self, timeout, default):
221
210
        if not default:
222
 
            message = 'Client {0} needs approval within {1} seconds'
 
211
            message = 'Client {} needs approval within {} seconds'
223
212
        else:
224
 
            message = 'Client {0} will get its secret in {1} seconds'
 
213
            message = 'Client {} will get its secret in {} seconds'
225
214
        self.logger(message.format(self.properties["Name"],
226
215
                                   timeout/1000))
227
216
    
228
217
    def rejected(self, reason):
229
 
        self.logger('Client {0} was rejected; reason: {1}'
 
218
        self.logger('Client {} was rejected; reason: {}'
230
219
                    .format(self.properties["Name"], reason))
231
220
    
232
221
    def selectable(self):
276
265
            else:
277
266
                timer = datetime.timedelta()
278
267
            if self.properties["ApprovedByDefault"]:
279
 
                message = "Approval in {0}. (d)eny?"
 
268
                message = "Approval in {}. (d)eny?"
280
269
            else:
281
 
                message = "Denial in {0}. (a)pprove?"
282
 
            message = message.format(unicode(timer).rsplit(".", 1)[0])
 
270
                message = "Denial in {}. (a)pprove?"
 
271
            message = message.format(str(timer).rsplit(".", 1)[0])
283
272
            self.using_timer(True)
284
273
        elif self.properties["LastCheckerStatus"] != 0:
285
274
            # When checker has failed, show timer until client expires
292
281
                timer = max(expires - datetime.datetime.utcnow(),
293
282
                            datetime.timedelta())
294
283
            message = ('A checker has failed! Time until client'
295
 
                       ' gets disabled: {0}'
296
 
                       .format(unicode(timer).rsplit(".", 1)[0]))
 
284
                       ' gets disabled: {}'
 
285
                       .format(str(timer).rsplit(".", 1)[0]))
297
286
            self.using_timer(True)
298
287
        else:
299
288
            message = "enabled"
300
289
            self.using_timer(False)
301
 
        self._text = "{0}{1}".format(base, message)
 
290
        self._text = "{}{}".format(base, message)
302
291
        
303
292
        if not urwid.supports_unicode():
304
293
            self._text = self._text.encode("ascii", "replace")
317
306
            self.update_hook()
318
307
    
319
308
    def update_timer(self):
320
 
        """called by gobject. Will indefinitely loop until
321
 
        gobject.source_remove() on tag is called"""
 
309
        """called by GLib. Will indefinitely loop until
 
310
        GLib.source_remove() on tag is called
 
311
        """
322
312
        self.update()
323
313
        return True             # Keep calling this
324
314
    
325
315
    def delete(self, **kwargs):
326
316
        if self._update_timer_callback_tag is not None:
327
 
            gobject.source_remove(self._update_timer_callback_tag)
 
317
            GLib.source_remove(self._update_timer_callback_tag)
328
318
            self._update_timer_callback_tag = None
329
319
        for match in self.match_objects:
330
320
            match.remove()
343
333
        """Handle keys.
344
334
        This overrides the method from urwid.FlowWidget"""
345
335
        if key == "+":
346
 
            self.proxy.Enable(dbus_interface = client_interface,
347
 
                              ignore_reply=True)
 
336
            self.proxy.Set(client_interface, "Enabled",
 
337
                           dbus.Boolean(True), ignore_reply = True,
 
338
                           dbus_interface = dbus.PROPERTIES_IFACE)
348
339
        elif key == "-":
349
 
            self.proxy.Disable(dbus_interface = client_interface,
350
 
                               ignore_reply=True)
 
340
            self.proxy.Set(client_interface, "Enabled", False,
 
341
                           ignore_reply = True,
 
342
                           dbus_interface = dbus.PROPERTIES_IFACE)
351
343
        elif key == "a":
352
344
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
353
345
                               dbus_interface = client_interface,
361
353
                                                  .object_path,
362
354
                                                  ignore_reply=True)
363
355
        elif key == "s":
364
 
            self.proxy.StartChecker(dbus_interface = client_interface,
365
 
                                    ignore_reply=True)
 
356
            self.proxy.Set(client_interface, "CheckerRunning",
 
357
                           dbus.Boolean(True), ignore_reply = True,
 
358
                           dbus_interface = dbus.PROPERTIES_IFACE)
366
359
        elif key == "S":
367
 
            self.proxy.StopChecker(dbus_interface = client_interface,
368
 
                                   ignore_reply=True)
 
360
            self.proxy.Set(client_interface, "CheckerRunning",
 
361
                           dbus.Boolean(False), ignore_reply = True,
 
362
                           dbus_interface = dbus.PROPERTIES_IFACE)
369
363
        elif key == "C":
370
364
            self.proxy.CheckedOK(dbus_interface = client_interface,
371
365
                                 ignore_reply=True)
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)
465
463
                              "q: Quit  ?: Help"))
466
464
        
467
465
        self.busname = domain + '.Mandos'
468
 
        self.main_loop = gobject.MainLoop()
 
466
        self.main_loop = GLib.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
 
    def find_and_remove_client(self, path, name):
 
528
    def find_and_remove_client(self, path, interfaces):
524
529
        """Find a client by its object path and remove it.
525
530
        
526
 
        This is connected to the ClientRemoved signal from the
 
531
        This is connected to the InterfacesRemoved signal from the
527
532
        Mandos server object."""
 
533
        if client_interface not in interfaces:
 
534
            # Not a Mandos client object; ignore
 
535
            return
528
536
        try:
529
537
            client = self.clients_dict[path]
530
538
        except KeyError:
531
539
            # not found?
532
 
            self.log_message("Unknown client {0!r} ({1!r}) removed"
533
 
                             .format(name, path))
 
540
            self.log_message("Unknown client {!r} removed"
 
541
                             .format(path))
534
542
            return
535
543
        client.delete()
536
544
    
537
 
    def add_new_client(self, path):
 
545
    def add_new_client(self, path, ifs_and_props):
 
546
        """Find a client by its object path and remove it.
 
547
        
 
548
        This is connected to the InterfacesAdded signal from the
 
549
        Mandos server object.
 
550
        """
 
551
        if client_interface not in ifs_and_props:
 
552
            # Not a Mandos client object; ignore
 
553
            return
538
554
        client_proxy_object = self.bus.get_object(self.busname, path)
539
555
        self.add_client(MandosClientWidget(server_proxy_object
540
556
                                           =self.mandos_serv,
545
561
                                           delete_hook
546
562
                                           =self.remove_client,
547
563
                                           logger
548
 
                                           =self.log_message),
 
564
                                           =self.log_message,
 
565
                                           properties
 
566
                                           = dict(ifs_and_props[
 
567
                                               client_interface])),
549
568
                        path=path)
550
569
    
551
570
    def add_client(self, client, path=None):
553
572
        if path is None:
554
573
            path = client.proxy.object_path
555
574
        self.clients_dict[path] = client
556
 
        self.clients.sort(None, lambda c: c.properties["Name"])
 
575
        self.clients.sort(key=lambda c: c.properties["Name"])
557
576
        self.refresh()
558
577
    
559
578
    def remove_client(self, client, path=None):
561
580
        if path is None:
562
581
            path = client.proxy.object_path
563
582
        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
583
        self.refresh()
570
584
    
571
585
    def refresh(self):
584
598
        try:
585
599
            mandos_clients = (self.mandos_serv
586
600
                              .GetAllClientsWithProperties())
 
601
            if not mandos_clients:
 
602
                self.log_message_raw(("bold", "Note: Server has no clients."))
587
603
        except dbus.exceptions.DBusException:
 
604
            self.log_message_raw(("bold", "Note: No Mandos server running."))
588
605
            mandos_clients = dbus.Dictionary()
589
606
        
590
607
        (self.mandos_serv
591
 
         .connect_to_signal("ClientRemoved",
 
608
         .connect_to_signal("InterfacesRemoved",
592
609
                            self.find_and_remove_client,
593
 
                            dbus_interface=server_interface,
 
610
                            dbus_interface
 
611
                            = dbus.OBJECT_MANAGER_IFACE,
594
612
                            byte_arrays=True))
595
613
        (self.mandos_serv
596
 
         .connect_to_signal("ClientAdded",
 
614
         .connect_to_signal("InterfacesAdded",
597
615
                            self.add_new_client,
598
 
                            dbus_interface=server_interface,
 
616
                            dbus_interface
 
617
                            = dbus.OBJECT_MANAGER_IFACE,
599
618
                            byte_arrays=True))
600
619
        (self.mandos_serv
601
620
         .connect_to_signal("ClientNotFound",
602
621
                            self.client_not_found,
603
622
                            dbus_interface=server_interface,
604
623
                            byte_arrays=True))
605
 
        for path, client in mandos_clients.iteritems():
 
624
        for path, client in mandos_clients.items():
606
625
            client_proxy_object = self.bus.get_object(self.busname,
607
626
                                                      path)
608
627
            self.add_client(MandosClientWidget(server_proxy_object
619
638
                            path=path)
620
639
        
621
640
        self.refresh()
622
 
        self._input_callback_tag = (gobject.io_add_watch
 
641
        self._input_callback_tag = (GLib.io_add_watch
623
642
                                    (sys.stdin.fileno(),
624
 
                                     gobject.IO_IN,
 
643
                                     GLib.IO_IN,
625
644
                                     self.process_input))
626
645
        self.main_loop.run()
627
646
        # Main loop has finished, we should close everything now
628
 
        gobject.source_remove(self._input_callback_tag)
 
647
        GLib.source_remove(self._input_callback_tag)
629
648
        self.screen.stop()
630
649
    
631
650
    def stop(self):
655
674
            elif key == "window resize":
656
675
                self.size = self.screen.get_cols_rows()
657
676
                self.refresh()
658
 
            elif key == "\f":  # Ctrl-L
 
677
            elif key == "ctrl l":
 
678
                self.screen.clear()
659
679
                self.refresh()
660
680
            elif key == "l" or key == "D":
661
681
                self.toggle_log_display()
673
693
                                            "?: Help",
674
694
                                            "l: Log window toggle",
675
695
                                            "TAB: Switch window",
676
 
                                            "w: Wrap (log)"))))
 
696
                                            "w: Wrap (log lines)",
 
697
                                            "v: Toggle verbose log",
 
698
                                            ))))
677
699
                self.log_message_raw(("bold",
678
700
                                      "  "
679
701
                                      .join(("Clients:",
692
714
                else:
693
715
                    self.topwidget.set_focus(self.logbox)
694
716
                self.refresh()
 
717
            elif key == "v":
 
718
                if self.log_level == 0:
 
719
                    self.log_level = 1
 
720
                    self.log_message("Verbose mode: Off")
 
721
                else:
 
722
                    self.log_level = 0
 
723
                    self.log_message("Verbose mode: On")
695
724
            #elif (key == "end" or key == "meta >" or key == "G"
696
725
            #      or key == ">"):
697
726
            #    pass            # xxx end-of-buffer
720
749
    ui.run()
721
750
except KeyboardInterrupt:
722
751
    ui.screen.stop()
723
 
except Exception, e:
724
 
    ui.log_message(unicode(e))
 
752
except Exception as e:
 
753
    ui.log_message(str(e))
725
754
    ui.screen.stop()
726
755
    raise