/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2016-03-13 00:37:02 UTC
  • Revision ID: teddy@recompile.se-20160313003702-dulwtwt8ilpojra9
Server: Fix bug where it did not exit timely on signals

Use GLib.unix_signal_add() instead of signal.signal() to catch
signals; this will allow GLib to do its internal magic with signal
file descriptors.  (GLib does not handle signals properly otherwise.)
The function unix_signal_add() requires GLib 2.30 or later, which was
not required by PyGobject until version 3.7.1, so depend on this.

* INSTALL (Mandos Server): Document dependency on PyGObject 3.7.1
* mandos (main): Use GLib.unix_signal_add instead of signal.signal.
* init.d-mandos (do_stop): Remove workaround.
* mandos.service ([Service]): - '' -

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.6"
 
60
version = "1.7.5"
 
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}'
 
163
        self.logger('Created client {}'
165
164
                    .format(self.properties["Name"]), level=0)
166
165
    
167
166
    def using_timer(self, flag):
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:
182
 
            self.logger('Checker for client {0} (command "{1}")'
 
181
            self.logger('Checker for client {} (command "{}")'
183
182
                        ' succeeded'.format(self.properties["Name"],
184
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
200
        """Server signals that a checker started."""
210
 
        self.logger('Client {0} started checker "{1}"'
 
201
        self.logger('Client {} started checker "{}"'
211
202
                    .format(self.properties["Name"],
212
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
 
466
463
                              "q: Quit  ?: Help"))
467
464
        
468
465
        self.busname = domain + '.Mandos'
469
 
        self.main_loop = gobject.MainLoop()
 
466
        self.main_loop = GLib.MainLoop()
470
467
    
471
468
    def client_not_found(self, fingerprint, address):
472
 
        self.log_message("Client with address {0} and fingerprint"
473
 
                         " {1} could not be found"
 
469
        self.log_message("Client with address {} and fingerprint {}"
 
470
                         " could not be found"
474
471
                         .format(address, fingerprint))
475
472
    
476
473
    def rebuild(self):
494
491
        if level < self.log_level:
495
492
            return
496
493
        timestamp = datetime.datetime.now().isoformat()
497
 
        self.log_message_raw("{0}: {1}".format(timestamp, message),
 
494
        self.log_message_raw("{}: {}".format(timestamp, message),
498
495
                             level=level)
499
496
    
500
497
    def log_message_raw(self, markup, level=1):
513
510
        """Toggle visibility of the log buffer."""
514
511
        self.log_visible = not self.log_visible
515
512
        self.rebuild()
516
 
        self.log_message("Log visibility changed to: {0}"
 
513
        self.log_message("Log visibility changed to: {}"
517
514
                         .format(self.log_visible), level=0)
518
515
    
519
516
    def change_log_display(self):
525
522
            self.log_wrap = "clip"
526
523
        for textwidget in self.log:
527
524
            textwidget.set_wrap_mode(self.log_wrap)
528
 
        self.log_message("Wrap mode: {0}".format(self.log_wrap),
 
525
        self.log_message("Wrap mode: {}".format(self.log_wrap),
529
526
                         level=0)
530
527
    
531
 
    def find_and_remove_client(self, path, name):
 
528
    def find_and_remove_client(self, path, interfaces):
532
529
        """Find a client by its object path and remove it.
533
530
        
534
 
        This is connected to the ClientRemoved signal from the
 
531
        This is connected to the InterfacesRemoved signal from the
535
532
        Mandos server object."""
 
533
        if client_interface not in interfaces:
 
534
            # Not a Mandos client object; ignore
 
535
            return
536
536
        try:
537
537
            client = self.clients_dict[path]
538
538
        except KeyError:
539
539
            # not found?
540
 
            self.log_message("Unknown client {0!r} ({1!r}) removed"
541
 
                             .format(name, path))
 
540
            self.log_message("Unknown client {!r} removed"
 
541
                             .format(path))
542
542
            return
543
543
        client.delete()
544
544
    
545
 
    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
546
554
        client_proxy_object = self.bus.get_object(self.busname, path)
547
555
        self.add_client(MandosClientWidget(server_proxy_object
548
556
                                           =self.mandos_serv,
553
561
                                           delete_hook
554
562
                                           =self.remove_client,
555
563
                                           logger
556
 
                                           =self.log_message),
 
564
                                           =self.log_message,
 
565
                                           properties
 
566
                                           = dict(ifs_and_props[
 
567
                                               client_interface])),
557
568
                        path=path)
558
569
    
559
570
    def add_client(self, client, path=None):
594
605
            mandos_clients = dbus.Dictionary()
595
606
        
596
607
        (self.mandos_serv
597
 
         .connect_to_signal("ClientRemoved",
 
608
         .connect_to_signal("InterfacesRemoved",
598
609
                            self.find_and_remove_client,
599
 
                            dbus_interface=server_interface,
 
610
                            dbus_interface
 
611
                            = dbus.OBJECT_MANAGER_IFACE,
600
612
                            byte_arrays=True))
601
613
        (self.mandos_serv
602
 
         .connect_to_signal("ClientAdded",
 
614
         .connect_to_signal("InterfacesAdded",
603
615
                            self.add_new_client,
604
 
                            dbus_interface=server_interface,
 
616
                            dbus_interface
 
617
                            = dbus.OBJECT_MANAGER_IFACE,
605
618
                            byte_arrays=True))
606
619
        (self.mandos_serv
607
620
         .connect_to_signal("ClientNotFound",
625
638
                            path=path)
626
639
        
627
640
        self.refresh()
628
 
        self._input_callback_tag = (gobject.io_add_watch
 
641
        self._input_callback_tag = (GLib.io_add_watch
629
642
                                    (sys.stdin.fileno(),
630
 
                                     gobject.IO_IN,
 
643
                                     GLib.IO_IN,
631
644
                                     self.process_input))
632
645
        self.main_loop.run()
633
646
        # Main loop has finished, we should close everything now
634
 
        gobject.source_remove(self._input_callback_tag)
 
647
        GLib.source_remove(self._input_callback_tag)
635
648
        self.screen.stop()
636
649
    
637
650
    def stop(self):
661
674
            elif key == "window resize":
662
675
                self.size = self.screen.get_cols_rows()
663
676
                self.refresh()
664
 
            elif key == "\f":  # Ctrl-L
 
677
            elif key == "ctrl l":
 
678
                self.screen.clear()
665
679
                self.refresh()
666
680
            elif key == "l" or key == "D":
667
681
                self.toggle_log_display()