/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-17 21:18:37 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 341.
  • Revision ID: teddy@recompile.se-20160317211837-f2tz0c9284rsv3k8
Client: Document default directories more clearly

Document default plugin directory and default plugin helper directory
also in the FILES section of the manual.

* plugin-runner.xml (FILES): Add "/lib/mandos/plugins.d" and
                             "/lib/mandos/plugin-helpers".

Show diffs side-by-side

added added

removed removed

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