/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-19 22:00:38 UTC
  • Revision ID: teddy@recompile.se-20160319220038-mexjdy1ct3wzld5t
Tags: version-1.7.7-1
* Makefile (version): Changed to "1.7.7".
* NEWS (Version 1.7.7): New entry.
* debian/changelog (1.7.7-1): - '' -

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-2013 Teddy Hogeborn
7
 
# Copyright © 2009-2013 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
32
32
 
33
33
import sys
34
34
import os
35
 
import signal
36
35
 
37
36
import datetime
38
37
 
40
39
import urwid
41
40
 
42
41
from dbus.mainloop.glib import DBusGMainLoop
43
 
try:
44
 
    import gobject
45
 
except ImportError:
46
 
    from gi.repository import GObject as gobject
 
42
from gi.repository import GLib
47
43
 
48
44
import dbus
49
45
 
50
46
import locale
51
47
 
52
 
if sys.version_info[0] == 2:
 
48
if sys.version_info.major == 2:
53
49
    str = unicode
54
50
 
55
51
locale.setlocale(locale.LC_ALL, '')
61
57
domain = 'se.recompile'
62
58
server_interface = domain + '.Mandos'
63
59
client_interface = domain + '.Mandos.Client'
64
 
version = "1.6.3"
 
60
version = "1.7.7"
 
61
 
 
62
try:
 
63
    dbus.OBJECT_MANAGER_IFACE
 
64
except AttributeError:
 
65
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
65
66
 
66
67
def isoformat_to_datetime(iso):
67
68
    "Parse an ISO 8601 date string to a datetime.datetime()"
88
89
        self.proxy = proxy_object # Mandos Client proxy object
89
90
        self.properties = dict() if properties is None else properties
90
91
        self.property_changed_match = (
91
 
            self.proxy.connect_to_signal("PropertyChanged",
92
 
                                         self._property_changed,
93
 
                                         client_interface,
 
92
            self.proxy.connect_to_signal("PropertiesChanged",
 
93
                                         self.properties_changed,
 
94
                                         dbus.PROPERTIES_IFACE,
94
95
                                         byte_arrays=True))
95
96
        
96
97
        if properties is None:
101
102
        
102
103
        super(MandosClientPropertyCache, self).__init__(**kwargs)
103
104
    
104
 
    def _property_changed(self, property, value):
105
 
        """Helper which takes positional arguments"""
106
 
        return self.property_changed(property=property, value=value)
107
 
    
108
 
    def property_changed(self, property=None, value=None):
109
 
        """This is called whenever we get a PropertyChanged signal
110
 
        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.
111
108
        """
112
109
        # Update properties dict with new value
113
 
        self.properties[property] = value
 
110
        if interface == client_interface:
 
111
            self.properties.update(properties)
114
112
    
115
113
    def delete(self):
116
114
        self.property_changed_match.remove()
162
160
                                         self.rejected,
163
161
                                         client_interface,
164
162
                                         byte_arrays=True))
165
 
        #self.logger('Created client {0}'
166
 
        #            .format(self.properties["Name"]))
 
163
        self.logger('Created client {}'
 
164
                    .format(self.properties["Name"]), level=0)
167
165
    
168
166
    def using_timer(self, flag):
169
167
        """Call this method with True or False when timer should be
171
169
        """
172
170
        if flag and self._update_timer_callback_tag is None:
173
171
            # Will update the shown timer value every second
174
 
            self._update_timer_callback_tag = (gobject.timeout_add
 
172
            self._update_timer_callback_tag = (GLib.timeout_add
175
173
                                               (1000,
176
174
                                                self.update_timer))
177
175
        elif not (flag or self._update_timer_callback_tag is None):
178
 
            gobject.source_remove(self._update_timer_callback_tag)
 
176
            GLib.source_remove(self._update_timer_callback_tag)
179
177
            self._update_timer_callback_tag = None
180
178
    
181
179
    def checker_completed(self, exitstatus, condition, command):
182
180
        if exitstatus == 0:
 
181
            self.logger('Checker for client {} (command "{}")'
 
182
                        ' succeeded'.format(self.properties["Name"],
 
183
                                            command), level=0)
183
184
            self.update()
184
185
            return
185
186
        # Checker failed
186
187
        if os.WIFEXITED(condition):
187
 
            self.logger('Checker for client {0} (command "{1}")'
188
 
                        ' failed with exit code {2}'
 
188
            self.logger('Checker for client {} (command "{}") failed'
 
189
                        ' with exit code {}'
189
190
                        .format(self.properties["Name"], command,
190
191
                                os.WEXITSTATUS(condition)))
191
192
        elif os.WIFSIGNALED(condition):
192
 
            self.logger('Checker for client {0} (command "{1}") was'
193
 
                        ' killed by signal {2}'
 
193
            self.logger('Checker for client {} (command "{}") was'
 
194
                        ' killed by signal {}'
194
195
                        .format(self.properties["Name"], command,
195
196
                                os.WTERMSIG(condition)))
196
 
        elif os.WCOREDUMP(condition):
197
 
            self.logger('Checker for client {0} (command "{1}")'
198
 
                        ' dumped core'
199
 
                        .format(self.properties["Name"], command))
200
 
        else:
201
 
            self.logger('Checker for client {0} completed'
202
 
                        ' mysteriously'
203
 
                        .format(self.properties["Name"]))
204
197
        self.update()
205
198
    
206
199
    def checker_started(self, command):
207
 
        """Server signals that a checker started. This could be useful
208
 
           to log in the future. """
209
 
        #self.logger('Client {0} started checker "{1}"'
210
 
        #            .format(self.properties["Name"],
211
 
        #                    str(command)))
212
 
        pass
 
200
        """Server signals that a checker started."""
 
201
        self.logger('Client {} started checker "{}"'
 
202
                    .format(self.properties["Name"],
 
203
                            command), level=0)
213
204
    
214
205
    def got_secret(self):
215
 
        self.logger('Client {0} received its secret'
 
206
        self.logger('Client {} received its secret'
216
207
                    .format(self.properties["Name"]))
217
208
    
218
209
    def need_approval(self, timeout, default):
219
210
        if not default:
220
 
            message = 'Client {0} needs approval within {1} seconds'
 
211
            message = 'Client {} needs approval within {} seconds'
221
212
        else:
222
 
            message = 'Client {0} will get its secret in {1} seconds'
 
213
            message = 'Client {} will get its secret in {} seconds'
223
214
        self.logger(message.format(self.properties["Name"],
224
215
                                   timeout/1000))
225
216
    
226
217
    def rejected(self, reason):
227
 
        self.logger('Client {0} was rejected; reason: {1}'
 
218
        self.logger('Client {} was rejected; reason: {}'
228
219
                    .format(self.properties["Name"], reason))
229
220
    
230
221
    def selectable(self):
274
265
            else:
275
266
                timer = datetime.timedelta()
276
267
            if self.properties["ApprovedByDefault"]:
277
 
                message = "Approval in {0}. (d)eny?"
 
268
                message = "Approval in {}. (d)eny?"
278
269
            else:
279
 
                message = "Denial in {0}. (a)pprove?"
 
270
                message = "Denial in {}. (a)pprove?"
280
271
            message = message.format(str(timer).rsplit(".", 1)[0])
281
272
            self.using_timer(True)
282
273
        elif self.properties["LastCheckerStatus"] != 0:
290
281
                timer = max(expires - datetime.datetime.utcnow(),
291
282
                            datetime.timedelta())
292
283
            message = ('A checker has failed! Time until client'
293
 
                       ' gets disabled: {0}'
 
284
                       ' gets disabled: {}'
294
285
                       .format(str(timer).rsplit(".", 1)[0]))
295
286
            self.using_timer(True)
296
287
        else:
297
288
            message = "enabled"
298
289
            self.using_timer(False)
299
 
        self._text = "{0}{1}".format(base, message)
 
290
        self._text = "{}{}".format(base, message)
300
291
        
301
292
        if not urwid.supports_unicode():
302
293
            self._text = self._text.encode("ascii", "replace")
315
306
            self.update_hook()
316
307
    
317
308
    def update_timer(self):
318
 
        """called by gobject. Will indefinitely loop until
319
 
        gobject.source_remove() on tag is called"""
 
309
        """called by GLib. Will indefinitely loop until
 
310
        GLib.source_remove() on tag is called
 
311
        """
320
312
        self.update()
321
313
        return True             # Keep calling this
322
314
    
323
315
    def delete(self, **kwargs):
324
316
        if self._update_timer_callback_tag is not None:
325
 
            gobject.source_remove(self._update_timer_callback_tag)
 
317
            GLib.source_remove(self._update_timer_callback_tag)
326
318
            self._update_timer_callback_tag = None
327
319
        for match in self.match_objects:
328
320
            match.remove()
341
333
        """Handle keys.
342
334
        This overrides the method from urwid.FlowWidget"""
343
335
        if key == "+":
344
 
            self.proxy.Enable(dbus_interface = client_interface,
345
 
                              ignore_reply=True)
 
336
            self.proxy.Set(client_interface, "Enabled",
 
337
                           dbus.Boolean(True), ignore_reply = True,
 
338
                           dbus_interface = dbus.PROPERTIES_IFACE)
346
339
        elif key == "-":
347
 
            self.proxy.Disable(dbus_interface = client_interface,
348
 
                               ignore_reply=True)
 
340
            self.proxy.Set(client_interface, "Enabled", False,
 
341
                           ignore_reply = True,
 
342
                           dbus_interface = dbus.PROPERTIES_IFACE)
349
343
        elif key == "a":
350
344
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
351
345
                               dbus_interface = client_interface,
359
353
                                                  .object_path,
360
354
                                                  ignore_reply=True)
361
355
        elif key == "s":
362
 
            self.proxy.StartChecker(dbus_interface = client_interface,
363
 
                                    ignore_reply=True)
 
356
            self.proxy.Set(client_interface, "CheckerRunning",
 
357
                           dbus.Boolean(True), ignore_reply = True,
 
358
                           dbus_interface = dbus.PROPERTIES_IFACE)
364
359
        elif key == "S":
365
 
            self.proxy.StopChecker(dbus_interface = client_interface,
366
 
                                   ignore_reply=True)
 
360
            self.proxy.Set(client_interface, "CheckerRunning",
 
361
                           dbus.Boolean(False), ignore_reply = True,
 
362
                           dbus_interface = dbus.PROPERTIES_IFACE)
367
363
        elif key == "C":
368
364
            self.proxy.CheckedOK(dbus_interface = client_interface,
369
365
                                 ignore_reply=True)
377
373
        else:
378
374
            return key
379
375
    
380
 
    def property_changed(self, property=None, **kwargs):
381
 
        """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.
382
378
        This overrides the method from MandosClientPropertyCache"""
383
 
        property_name = str(property)
384
 
        old_value = self.properties.get(property_name)
385
 
        super(MandosClientWidget, self).property_changed(
386
 
            property=property, **kwargs)
387
 
        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):
388
385
            self.update()
389
386
 
390
387
 
404
401
    """This is the entire user interface - the whole screen
405
402
    with boxes, lists of client widgets, etc.
406
403
    """
407
 
    def __init__(self, max_log_length=1000):
 
404
    def __init__(self, max_log_length=1000, log_level=1):
408
405
        DBusGMainLoop(set_as_default=True)
409
406
        
410
407
        self.screen = urwid.curses_display.Screen()
448
445
        self.log = []
449
446
        self.max_log_length = max_log_length
450
447
        
 
448
        self.log_level = log_level
 
449
        
451
450
        # We keep a reference to the log widget so we can remove it
452
451
        # from the ListWalker without it getting destroyed
453
452
        self.logbox = ConstrainedListBox(self.log)
464
463
                              "q: Quit  ?: Help"))
465
464
        
466
465
        self.busname = domain + '.Mandos'
467
 
        self.main_loop = gobject.MainLoop()
 
466
        self.main_loop = GLib.MainLoop()
468
467
    
469
468
    def client_not_found(self, fingerprint, address):
470
 
        self.log_message("Client with address {0} and fingerprint"
471
 
                         " {1} could not be found"
 
469
        self.log_message("Client with address {} and fingerprint {}"
 
470
                         " could not be found"
472
471
                         .format(address, fingerprint))
473
472
    
474
473
    def rebuild(self):
487
486
            self.uilist.append(self.logbox)
488
487
        self.topwidget = urwid.Pile(self.uilist)
489
488
    
490
 
    def log_message(self, message):
 
489
    def log_message(self, message, level=1):
491
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
 
        #                 + str(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):
586
605
            mandos_clients = dbus.Dictionary()
587
606
        
588
607
        (self.mandos_serv
589
 
         .connect_to_signal("ClientRemoved",
 
608
         .connect_to_signal("InterfacesRemoved",
590
609
                            self.find_and_remove_client,
591
 
                            dbus_interface=server_interface,
 
610
                            dbus_interface
 
611
                            = dbus.OBJECT_MANAGER_IFACE,
592
612
                            byte_arrays=True))
593
613
        (self.mandos_serv
594
 
         .connect_to_signal("ClientAdded",
 
614
         .connect_to_signal("InterfacesAdded",
595
615
                            self.add_new_client,
596
 
                            dbus_interface=server_interface,
 
616
                            dbus_interface
 
617
                            = dbus.OBJECT_MANAGER_IFACE,
597
618
                            byte_arrays=True))
598
619
        (self.mandos_serv
599
620
         .connect_to_signal("ClientNotFound",
617
638
                            path=path)
618
639
        
619
640
        self.refresh()
620
 
        self._input_callback_tag = (gobject.io_add_watch
 
641
        self._input_callback_tag = (GLib.io_add_watch
621
642
                                    (sys.stdin.fileno(),
622
 
                                     gobject.IO_IN,
 
643
                                     GLib.IO_IN,
623
644
                                     self.process_input))
624
645
        self.main_loop.run()
625
646
        # Main loop has finished, we should close everything now
626
 
        gobject.source_remove(self._input_callback_tag)
 
647
        GLib.source_remove(self._input_callback_tag)
627
648
        self.screen.stop()
628
649
    
629
650
    def stop(self):
653
674
            elif key == "window resize":
654
675
                self.size = self.screen.get_cols_rows()
655
676
                self.refresh()
656
 
            elif key == "\f":  # Ctrl-L
 
677
            elif key == "ctrl l":
 
678
                self.screen.clear()
657
679
                self.refresh()
658
680
            elif key == "l" or key == "D":
659
681
                self.toggle_log_display()
671
693
                                            "?: Help",
672
694
                                            "l: Log window toggle",
673
695
                                            "TAB: Switch window",
674
 
                                            "w: Wrap (log)"))))
 
696
                                            "w: Wrap (log lines)",
 
697
                                            "v: Toggle verbose log",
 
698
                                            ))))
675
699
                self.log_message_raw(("bold",
676
700
                                      "  "
677
701
                                      .join(("Clients:",
690
714
                else:
691
715
                    self.topwidget.set_focus(self.logbox)
692
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")
693
724
            #elif (key == "end" or key == "meta >" or key == "G"
694
725
            #      or key == ">"):
695
726
            #    pass            # xxx end-of-buffer