/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: 2011-03-08 19:09:03 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110308190903-j499ebtb9bpk31ar
* INSTALL: Updated.

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-2011 Teddy Hogeborn
 
7
# Copyright © 2009-2011 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
17
17
#     GNU General Public License for more details.
18
18
# 
19
19
# You should have received a copy of the GNU General Public License
20
 
# along with this program.  If not, see
21
 
# <http://www.gnu.org/licenses/>.
22
 
# 
23
 
# Contact the authors at <mandos@recompile.se>.
24
 
# 
25
 
 
26
 
from __future__ import (division, absolute_import, print_function,
27
 
                        unicode_literals)
28
 
 
29
 
from future_builtins import *
 
20
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
21
# 
 
22
# Contact the authors at <mandos@fukt.bsnet.se>.
 
23
# 
 
24
 
 
25
from __future__ import division, absolute_import, print_function, unicode_literals
30
26
 
31
27
import sys
32
28
import os
52
48
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
53
49
 
54
50
# Some useful constants
55
 
domain = 'se.recompile'
 
51
domain = 'se.bsnet.fukt'
56
52
server_interface = domain + '.Mandos'
57
53
client_interface = domain + '.Mandos.Client'
58
 
version = "1.5.3"
 
54
version = "1.2.3"
59
55
 
60
56
# Always run in monochrome mode
61
57
urwid.curses_display.curses.has_colors = lambda : False
90
86
        self.proxy = proxy_object # Mandos Client proxy object
91
87
        
92
88
        self.properties = dict()
93
 
        self.property_changed_match = (
94
 
            self.proxy.connect_to_signal("PropertyChanged",
95
 
                                         self.property_changed,
96
 
                                         client_interface,
97
 
                                         byte_arrays=True))
 
89
        self.proxy.connect_to_signal("PropertyChanged",
 
90
                                     self.property_changed,
 
91
                                     client_interface,
 
92
                                     byte_arrays=True)
98
93
        
99
94
        self.properties.update(
100
95
            self.proxy.GetAll(client_interface,
101
96
                              dbus_interface = dbus.PROPERTIES_IFACE))
102
97
 
103
 
        #XXX This breaks good super behaviour
 
98
        #XXX This break good super behaviour!
104
99
#        super(MandosClientPropertyCache, self).__init__(
105
100
#            *args, **kwargs)
106
101
    
110
105
        """
111
106
        # Update properties dict with new value
112
107
        self.properties[property] = value
113
 
    
114
 
    def delete(self, *args, **kwargs):
115
 
        self.property_changed_match.remove()
116
 
        super(MandosClientPropertyCache, self).__init__(
117
 
            *args, **kwargs)
118
108
 
119
109
 
120
110
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
134
124
        
135
125
        self._update_timer_callback_tag = None
136
126
        self._update_timer_callback_lock = 0
 
127
        self.last_checker_failed = False
137
128
        
138
129
        # The widget shown normally
139
130
        self._text_widget = urwid.Text("")
147
138
        
148
139
        last_checked_ok = isoformat_to_datetime(self.properties
149
140
                                                ["LastCheckedOK"])
 
141
        if last_checked_ok is None:
 
142
            self.last_checker_failed = True
 
143
        else:
 
144
            self.last_checker_failed = ((datetime.datetime.utcnow()
 
145
                                         - last_checked_ok)
 
146
                                        > datetime.timedelta
 
147
                                        (milliseconds=
 
148
                                         self.properties
 
149
                                         ["Interval"]))
150
150
        
151
 
        if self.properties ["LastCheckerStatus"] != 0:
 
151
        if self.last_checker_failed:
152
152
            self.using_timer(True)
153
153
        
154
154
        if self.need_approval:
155
155
            self.using_timer(True)
156
156
        
157
 
        self.match_objects = (
158
 
            self.proxy.connect_to_signal("CheckerCompleted",
159
 
                                         self.checker_completed,
160
 
                                         client_interface,
161
 
                                         byte_arrays=True),
162
 
            self.proxy.connect_to_signal("CheckerStarted",
163
 
                                         self.checker_started,
164
 
                                         client_interface,
165
 
                                         byte_arrays=True),
166
 
            self.proxy.connect_to_signal("GotSecret",
167
 
                                         self.got_secret,
168
 
                                         client_interface,
169
 
                                         byte_arrays=True),
170
 
            self.proxy.connect_to_signal("NeedApproval",
171
 
                                         self.need_approval,
172
 
                                         client_interface,
173
 
                                         byte_arrays=True),
174
 
            self.proxy.connect_to_signal("Rejected",
175
 
                                         self.rejected,
176
 
                                         client_interface,
177
 
                                         byte_arrays=True))
178
 
        #self.logger('Created client {0}'
179
 
        #            .format(self.properties["Name"]))
 
157
        self.proxy.connect_to_signal("CheckerCompleted",
 
158
                                     self.checker_completed,
 
159
                                     client_interface,
 
160
                                     byte_arrays=True)
 
161
        self.proxy.connect_to_signal("CheckerStarted",
 
162
                                     self.checker_started,
 
163
                                     client_interface,
 
164
                                     byte_arrays=True)
 
165
        self.proxy.connect_to_signal("GotSecret",
 
166
                                     self.got_secret,
 
167
                                     client_interface,
 
168
                                     byte_arrays=True)
 
169
        self.proxy.connect_to_signal("NeedApproval",
 
170
                                     self.need_approval,
 
171
                                     client_interface,
 
172
                                     byte_arrays=True)
 
173
        self.proxy.connect_to_signal("Rejected",
 
174
                                     self.rejected,
 
175
                                     client_interface,
 
176
                                     byte_arrays=True)
180
177
    
181
178
    def property_changed(self, property=None, value=None):
182
179
        super(self, MandosClientWidget).property_changed(property,
183
180
                                                         value)
184
181
        if property == "ApprovalPending":
185
182
            using_timer(bool(value))
186
 
        if property == "LastCheckerStatus":
187
 
            using_timer(value != 0)
188
 
            #self.logger('Checker for client {0} (command "{1}") was '
189
 
            #            ' successful'.format(self.properties["Name"],
190
 
            #                                 command))
191
 
    
 
183
        
192
184
    def using_timer(self, flag):
193
185
        """Call this method with True or False when timer should be
194
186
        activated or deactivated.
199
191
        else:
200
192
            self._update_timer_callback_lock -= 1
201
193
        if old == 0 and self._update_timer_callback_lock:
202
 
            # Will update the shown timer value every second
203
194
            self._update_timer_callback_tag = (gobject.timeout_add
204
195
                                               (1000,
205
196
                                                self.update_timer))
209
200
    
210
201
    def checker_completed(self, exitstatus, condition, command):
211
202
        if exitstatus == 0:
 
203
            if self.last_checker_failed:
 
204
                self.last_checker_failed = False
 
205
                self.using_timer(False)
 
206
            #self.logger('Checker for client %s (command "%s")'
 
207
            #            ' was successful'
 
208
            #            % (self.properties["Name"], command))
212
209
            self.update()
213
210
            return
214
211
        # Checker failed
 
212
        if not self.last_checker_failed:
 
213
            self.last_checker_failed = True
 
214
            self.using_timer(True)
215
215
        if os.WIFEXITED(condition):
216
 
            self.logger('Checker for client {0} (command "{1}")'
217
 
                        ' failed with exit code {2}'
218
 
                        .format(self.properties["Name"], command,
219
 
                                os.WEXITSTATUS(condition)))
 
216
            self.logger('Checker for client %s (command "%s")'
 
217
                        ' failed with exit code %s'
 
218
                        % (self.properties["Name"], command,
 
219
                           os.WEXITSTATUS(condition)))
220
220
        elif os.WIFSIGNALED(condition):
221
 
            self.logger('Checker for client {0} (command "{1}") was'
222
 
                        ' killed by signal {2}'
223
 
                        .format(self.properties["Name"], command,
224
 
                                os.WTERMSIG(condition)))
 
221
            self.logger('Checker for client %s (command "%s")'
 
222
                        ' was killed by signal %s'
 
223
                        % (self.properties["Name"], command,
 
224
                           os.WTERMSIG(condition)))
225
225
        elif os.WCOREDUMP(condition):
226
 
            self.logger('Checker for client {0} (command "{1}")'
 
226
            self.logger('Checker for client %s (command "%s")'
227
227
                        ' dumped core'
228
 
                        .format(self.properties["Name"], command))
 
228
                        % (self.properties["Name"], command))
229
229
        else:
230
 
            self.logger('Checker for client {0} completed'
231
 
                        ' mysteriously'
232
 
                        .format(self.properties["Name"]))
 
230
            self.logger('Checker for client %s completed'
 
231
                        ' mysteriously')
233
232
        self.update()
234
233
    
235
234
    def checker_started(self, command):
236
 
        """Server signals that a checker started. This could be useful
237
 
           to log in the future. """
238
 
        #self.logger('Client {0} started checker "{1}"'
239
 
        #            .format(self.properties["Name"],
240
 
        #                    unicode(command)))
 
235
        #self.logger('Client %s started checker "%s"'
 
236
        #            % (self.properties["Name"], unicode(command)))
241
237
        pass
242
238
    
243
239
    def got_secret(self):
244
 
        self.logger('Client {0} received its secret'
245
 
                    .format(self.properties["Name"]))
 
240
        self.last_checker_failed = False
 
241
        self.logger('Client %s received its secret'
 
242
                    % self.properties["Name"])
246
243
    
247
244
    def need_approval(self, timeout, default):
248
245
        if not default:
249
 
            message = 'Client {0} needs approval within {1} seconds'
 
246
            message = 'Client %s needs approval within %s seconds'
250
247
        else:
251
 
            message = 'Client {0} will get its secret in {1} seconds'
252
 
        self.logger(message.format(self.properties["Name"],
253
 
                                   timeout/1000))
 
248
            message = 'Client %s will get its secret in %s seconds'
 
249
        self.logger(message
 
250
                    % (self.properties["Name"], timeout/1000))
254
251
        self.using_timer(True)
255
252
    
256
253
    def rejected(self, reason):
257
 
        self.logger('Client {0} was rejected; reason: {1}'
258
 
                    .format(self.properties["Name"], reason))
 
254
        self.logger('Client %s was rejected; reason: %s'
 
255
                    % (self.properties["Name"], reason))
259
256
    
260
257
    def selectable(self):
261
258
        """Make this a "selectable" widget.
287
284
        # Rebuild focus and non-focus widgets using current properties
288
285
 
289
286
        # Base part of a client. Name!
290
 
        base = '{name}: '.format(name=self.properties["Name"])
 
287
        base = ('%(name)s: '
 
288
                      % {"name": self.properties["Name"]})
291
289
        if not self.properties["Enabled"]:
292
290
            message = "DISABLED"
293
291
        elif self.properties["ApprovalPending"]:
302
300
            else:
303
301
                timer = datetime.timedelta()
304
302
            if self.properties["ApprovedByDefault"]:
305
 
                message = "Approval in {0}. (d)eny?"
306
 
            else:
307
 
                message = "Denial in {0}. (a)pprove?"
308
 
            message = message.format(unicode(timer).rsplit(".", 1)[0])
309
 
        elif self.properties["LastCheckerStatus"] != 0:
310
 
            # When checker has failed, show timer until client expires
311
 
            expires = self.properties["Expires"]
312
 
            if expires == "":
313
 
                timer = datetime.timedelta(0)
314
 
            else:
315
 
                expires = (datetime.datetime.strptime
316
 
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
317
 
                timer = expires - datetime.datetime.utcnow()
 
303
                message = "Approval in %s. (d)eny?"
 
304
            else:
 
305
                message = "Denial in %s. (a)pprove?"
 
306
            message = message % unicode(timer).rsplit(".", 1)[0]
 
307
        elif self.last_checker_failed:
 
308
            timeout = datetime.timedelta(milliseconds
 
309
                                         = self.properties
 
310
                                         ["Timeout"])
 
311
            last_ok = isoformat_to_datetime(
 
312
                max((self.properties["LastCheckedOK"]
 
313
                     or self.properties["Created"]),
 
314
                    self.properties["LastEnabled"]))
 
315
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
318
316
            message = ('A checker has failed! Time until client'
319
 
                       ' gets disabled: {0}'
320
 
                       .format(unicode(timer).rsplit(".", 1)[0]))
 
317
                       ' gets disabled: %s'
 
318
                           % unicode(timer).rsplit(".", 1)[0])
321
319
        else:
322
320
            message = "enabled"
323
 
        self._text = "{0}{1}".format(base, message)
 
321
        self._text = "%s%s" % (base, message)
324
322
            
325
323
        if not urwid.supports_unicode():
326
324
            self._text = self._text.encode("ascii", "replace")
339
337
            self.update_hook()
340
338
    
341
339
    def update_timer(self):
342
 
        """called by gobject. Will indefinitely loop until
343
 
        gobject.source_remove() on tag is called"""
 
340
        "called by gobject"
344
341
        self.update()
345
342
        return True             # Keep calling this
346
343
    
347
 
    def delete(self, *args, **kwargs):
 
344
    def delete(self):
348
345
        if self._update_timer_callback_tag is not None:
349
346
            gobject.source_remove(self._update_timer_callback_tag)
350
347
            self._update_timer_callback_tag = None
351
 
        for match in self.match_objects:
352
 
            match.remove()
353
 
        self.match_objects = ()
354
348
        if self.delete_hook is not None:
355
349
            self.delete_hook(self)
356
 
        return super(MandosClientWidget, self).delete(*args, **kwargs)
357
350
    
358
351
    def render(self, maxcolrow, focus=False):
359
352
        """Render differently if we have focus.
365
358
        """Handle keys.
366
359
        This overrides the method from urwid.FlowWidget"""
367
360
        if key == "+":
368
 
            self.proxy.Enable(dbus_interface = client_interface,
369
 
                              ignore_reply=True)
 
361
            self.proxy.Enable(dbus_interface = client_interface)
370
362
        elif key == "-":
371
 
            self.proxy.Disable(dbus_interface = client_interface,
372
 
                               ignore_reply=True)
 
363
            self.proxy.Disable(dbus_interface = client_interface)
373
364
        elif key == "a":
374
365
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
375
 
                               dbus_interface = client_interface,
376
 
                               ignore_reply=True)
 
366
                               dbus_interface = client_interface)
377
367
        elif key == "d":
378
368
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
379
 
                                  dbus_interface = client_interface,
380
 
                               ignore_reply=True)
 
369
                                  dbus_interface = client_interface)
381
370
        elif key == "R" or key == "_" or key == "ctrl k":
382
371
            self.server_proxy_object.RemoveClient(self.proxy
383
 
                                                  .object_path,
384
 
                                                  ignore_reply=True)
 
372
                                                  .object_path)
385
373
        elif key == "s":
386
 
            self.proxy.StartChecker(dbus_interface = client_interface,
387
 
                                    ignore_reply=True)
 
374
            self.proxy.StartChecker(dbus_interface = client_interface)
388
375
        elif key == "S":
389
 
            self.proxy.StopChecker(dbus_interface = client_interface,
390
 
                                   ignore_reply=True)
 
376
            self.proxy.StopChecker(dbus_interface = client_interface)
391
377
        elif key == "C":
392
 
            self.proxy.CheckedOK(dbus_interface = client_interface,
393
 
                                 ignore_reply=True)
 
378
            self.proxy.CheckedOK(dbus_interface = client_interface)
394
379
        # xxx
395
380
#         elif key == "p" or key == "=":
396
381
#             self.proxy.pause()
489
474
        
490
475
        self.busname = domain + '.Mandos'
491
476
        self.main_loop = gobject.MainLoop()
 
477
        self.bus = dbus.SystemBus()
 
478
        mandos_dbus_objc = self.bus.get_object(
 
479
            self.busname, "/", follow_name_owner_changes=True)
 
480
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
481
                                          dbus_interface
 
482
                                          = server_interface)
 
483
        try:
 
484
            mandos_clients = (self.mandos_serv
 
485
                              .GetAllClientsWithProperties())
 
486
        except dbus.exceptions.DBusException:
 
487
            mandos_clients = dbus.Dictionary()
 
488
        
 
489
        (self.mandos_serv
 
490
         .connect_to_signal("ClientRemoved",
 
491
                            self.find_and_remove_client,
 
492
                            dbus_interface=server_interface,
 
493
                            byte_arrays=True))
 
494
        (self.mandos_serv
 
495
         .connect_to_signal("ClientAdded",
 
496
                            self.add_new_client,
 
497
                            dbus_interface=server_interface,
 
498
                            byte_arrays=True))
 
499
        (self.mandos_serv
 
500
         .connect_to_signal("ClientNotFound",
 
501
                            self.client_not_found,
 
502
                            dbus_interface=server_interface,
 
503
                            byte_arrays=True))
 
504
        for path, client in mandos_clients.iteritems():
 
505
            client_proxy_object = self.bus.get_object(self.busname,
 
506
                                                      path)
 
507
            self.add_client(MandosClientWidget(server_proxy_object
 
508
                                               =self.mandos_serv,
 
509
                                               proxy_object
 
510
                                               =client_proxy_object,
 
511
                                               properties=client,
 
512
                                               update_hook
 
513
                                               =self.refresh,
 
514
                                               delete_hook
 
515
                                               =self.remove_client,
 
516
                                               logger
 
517
                                               =self.log_message),
 
518
                            path=path)
492
519
    
493
520
    def client_not_found(self, fingerprint, address):
494
 
        self.log_message("Client with address {0} and fingerprint"
495
 
                         " {1} could not be found"
496
 
                         .format(address, fingerprint))
 
521
        self.log_message(("Client with address %s and fingerprint %s"
 
522
                          " could not be found" % (address,
 
523
                                                    fingerprint)))
497
524
    
498
525
    def rebuild(self):
499
526
        """This rebuilds the User Interface.
509
536
                                                     self.divider)))
510
537
        if self.log_visible:
511
538
            self.uilist.append(self.logbox)
 
539
            pass
512
540
        self.topwidget = urwid.Pile(self.uilist)
513
541
    
514
542
    def log_message(self, message):
544
572
        #self.log_message("Wrap mode: " + self.log_wrap)
545
573
    
546
574
    def find_and_remove_client(self, path, name):
547
 
        """Find a client by its object path and remove it.
 
575
        """Find an client from its object path and remove it.
548
576
        
549
577
        This is connected to the ClientRemoved signal from the
550
578
        Mandos server object."""
552
580
            client = self.clients_dict[path]
553
581
        except KeyError:
554
582
            # not found?
555
 
            self.log_message("Unknown client {0!r} ({1!r}) removed"
556
 
                             .format(name, path))
557
583
            return
558
 
        client.delete()
 
584
        self.remove_client(client, path)
559
585
    
560
586
    def add_new_client(self, path):
561
587
        client_proxy_object = self.bus.get_object(self.busname, path)
598
624
    
599
625
    def run(self):
600
626
        """Start the main loop and exit when it's done."""
601
 
        self.bus = dbus.SystemBus()
602
 
        mandos_dbus_objc = self.bus.get_object(
603
 
            self.busname, "/", follow_name_owner_changes=True)
604
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
605
 
                                          dbus_interface
606
 
                                          = server_interface)
607
 
        try:
608
 
            mandos_clients = (self.mandos_serv
609
 
                              .GetAllClientsWithProperties())
610
 
        except dbus.exceptions.DBusException:
611
 
            mandos_clients = dbus.Dictionary()
612
 
        
613
 
        (self.mandos_serv
614
 
         .connect_to_signal("ClientRemoved",
615
 
                            self.find_and_remove_client,
616
 
                            dbus_interface=server_interface,
617
 
                            byte_arrays=True))
618
 
        (self.mandos_serv
619
 
         .connect_to_signal("ClientAdded",
620
 
                            self.add_new_client,
621
 
                            dbus_interface=server_interface,
622
 
                            byte_arrays=True))
623
 
        (self.mandos_serv
624
 
         .connect_to_signal("ClientNotFound",
625
 
                            self.client_not_found,
626
 
                            dbus_interface=server_interface,
627
 
                            byte_arrays=True))
628
 
        for path, client in mandos_clients.iteritems():
629
 
            client_proxy_object = self.bus.get_object(self.busname,
630
 
                                                      path)
631
 
            self.add_client(MandosClientWidget(server_proxy_object
632
 
                                               =self.mandos_serv,
633
 
                                               proxy_object
634
 
                                               =client_proxy_object,
635
 
                                               properties=client,
636
 
                                               update_hook
637
 
                                               =self.refresh,
638
 
                                               delete_hook
639
 
                                               =self.remove_client,
640
 
                                               logger
641
 
                                               =self.log_message),
642
 
                            path=path)
643
 
 
644
627
        self.refresh()
645
628
        self._input_callback_tag = (gobject.io_add_watch
646
629
                                    (sys.stdin.fileno(),