/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: 2013-10-26 19:05:21 UTC
  • Revision ID: teddy@recompile.se-20131026190521-giagilisbyciox2h
Fall back to /var/run for pidfile if /run is not a directory.

This is for old (possibly non-Debian) systems which have not migrated
from /var/run to /run yet.

* init.d-mandos (PIDFILE): Fall back to /var/run/mandos.pid if /run is
                           not a directory.
* mandos (pidfilename): - '' -
* mandos.xml (FILES): Document fallback to /var/run/mandos.pid if /run
                      is not a directory.

Reported-by: Nathanael D. Noblet <nathanael@gnat.ca>
Suggested-by: Nathanael D. Noblet <nathanael@gnat.ca>

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