/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: 2012-06-22 23:33:56 UTC
  • Revision ID: teddy@recompile.se-20120622233356-odoqqt2ki2gssn37
* Makefile (check): Also check mandos-ctl.
* mandos-ctl: All options taking a time interval argument can now take
              an RFC 3339 duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
  (main): New "--check" option.
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new "--check" option.

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-2011 Teddy Hogeborn
7
 
# Copyright © 2009-2011 Björn Påhlsson
 
6
# Copyright © 2009-2012 Teddy Hogeborn
 
7
# Copyright © 2009-2012 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 <http://www.gnu.org/licenses/>.
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
21
22
# 
22
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
23
# Contact the authors at <mandos@recompile.se>.
23
24
# 
24
25
 
25
26
from __future__ import (division, absolute_import, print_function,
26
27
                        unicode_literals)
27
28
 
 
29
from future_builtins import *
 
30
 
28
31
import sys
29
32
import os
30
33
import signal
49
52
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
50
53
 
51
54
# Some useful constants
52
 
domain = 'se.bsnet.fukt'
 
55
domain = 'se.recompile'
53
56
server_interface = domain + '.Mandos'
54
57
client_interface = domain + '.Mandos.Client'
55
 
version = "1.3.1"
 
58
version = "1.6.0"
56
59
 
57
60
# Always run in monochrome mode
58
61
urwid.curses_display.curses.has_colors = lambda : False
83
86
    properties and calls a hook function when any of them are
84
87
    changed.
85
88
    """
86
 
    def __init__(self, proxy_object=None, *args, **kwargs):
 
89
    def __init__(self, proxy_object=None, properties=None, **kwargs):
87
90
        self.proxy = proxy_object # Mandos Client proxy object
88
 
        
89
 
        self.properties = dict()
 
91
        self.properties = dict() if properties is None else properties
90
92
        self.property_changed_match = (
91
93
            self.proxy.connect_to_signal("PropertyChanged",
92
 
                                         self.property_changed,
 
94
                                         self._property_changed,
93
95
                                         client_interface,
94
96
                                         byte_arrays=True))
95
97
        
96
 
        self.properties.update(
97
 
            self.proxy.GetAll(client_interface,
98
 
                              dbus_interface = dbus.PROPERTIES_IFACE))
99
 
 
100
 
        #XXX This breaks good super behaviour
101
 
#        super(MandosClientPropertyCache, self).__init__(
102
 
#            *args, **kwargs)
 
98
        if properties is None:
 
99
            self.properties.update(
 
100
                self.proxy.GetAll(client_interface,
 
101
                                  dbus_interface
 
102
                                  = dbus.PROPERTIES_IFACE))
 
103
        
 
104
        super(MandosClientPropertyCache, self).__init__(**kwargs)
 
105
    
 
106
    def _property_changed(self, property, value):
 
107
        """Helper which takes positional arguments"""
 
108
        return self.property_changed(property=property, value=value)
103
109
    
104
110
    def property_changed(self, property=None, value=None):
105
111
        """This is called whenever we get a PropertyChanged signal
108
114
        # Update properties dict with new value
109
115
        self.properties[property] = value
110
116
    
111
 
    def delete(self, *args, **kwargs):
 
117
    def delete(self):
112
118
        self.property_changed_match.remove()
113
 
        super(MandosClientPropertyCache, self).__init__(
114
 
            *args, **kwargs)
115
119
 
116
120
 
117
121
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
119
123
    """
120
124
    
121
125
    def __init__(self, server_proxy_object=None, update_hook=None,
122
 
                 delete_hook=None, logger=None, *args, **kwargs):
 
126
                 delete_hook=None, logger=None, **kwargs):
123
127
        # Called on update
124
128
        self.update_hook = update_hook
125
129
        # Called on delete
130
134
        self.logger = logger
131
135
        
132
136
        self._update_timer_callback_tag = None
133
 
        self._update_timer_callback_lock = 0
134
 
        self.last_checker_failed = False
135
137
        
136
138
        # The widget shown normally
137
139
        self._text_widget = urwid.Text("")
138
140
        # The widget shown when we have focus
139
141
        self._focus_text_widget = urwid.Text("")
140
 
        super(MandosClientWidget, self).__init__(
141
 
            update_hook=update_hook, delete_hook=delete_hook,
142
 
            *args, **kwargs)
 
142
        super(MandosClientWidget, self).__init__(**kwargs)
143
143
        self.update()
144
144
        self.opened = False
145
145
        
146
 
        last_checked_ok = isoformat_to_datetime(self.properties
147
 
                                                ["LastCheckedOK"])
148
 
        if last_checked_ok is None:
149
 
            self.last_checker_failed = True
150
 
        else:
151
 
            self.last_checker_failed = ((datetime.datetime.utcnow()
152
 
                                         - last_checked_ok)
153
 
                                        > datetime.timedelta
154
 
                                        (milliseconds=
155
 
                                         self.properties
156
 
                                         ["Interval"]))
157
 
        
158
 
        if self.last_checker_failed:
159
 
            self.using_timer(True)
160
 
        
161
 
        if self.need_approval:
162
 
            self.using_timer(True)
163
 
        
164
146
        self.match_objects = (
165
147
            self.proxy.connect_to_signal("CheckerCompleted",
166
148
                                         self.checker_completed,
182
164
                                         self.rejected,
183
165
                                         client_interface,
184
166
                                         byte_arrays=True))
185
 
        #self.logger('Created client %s' % (self.properties["Name"]))
 
167
        #self.logger('Created client {0}'
 
168
        #            .format(self.properties["Name"]))
186
169
    
187
 
    def property_changed(self, property=None, value=None):
188
 
        super(self, MandosClientWidget).property_changed(property,
189
 
                                                         value)
190
 
        if property == "ApprovalPending":
191
 
            using_timer(bool(value))
192
 
        
193
170
    def using_timer(self, flag):
194
171
        """Call this method with True or False when timer should be
195
172
        activated or deactivated.
196
173
        """
197
 
        old = self._update_timer_callback_lock
198
 
        if flag:
199
 
            self._update_timer_callback_lock += 1
200
 
        else:
201
 
            self._update_timer_callback_lock -= 1
202
 
        if old == 0 and self._update_timer_callback_lock:
 
174
        if flag and self._update_timer_callback_tag is None:
 
175
            # Will update the shown timer value every second
203
176
            self._update_timer_callback_tag = (gobject.timeout_add
204
177
                                               (1000,
205
178
                                                self.update_timer))
206
 
        elif old and self._update_timer_callback_lock == 0:
 
179
        elif not (flag or self._update_timer_callback_tag is None):
207
180
            gobject.source_remove(self._update_timer_callback_tag)
208
181
            self._update_timer_callback_tag = None
209
182
    
210
183
    def checker_completed(self, exitstatus, condition, command):
211
184
        if exitstatus == 0:
212
 
            if self.last_checker_failed:
213
 
                self.last_checker_failed = False
214
 
                self.using_timer(False)
215
 
            #self.logger('Checker for client %s (command "%s")'
216
 
            #            ' was successful'
217
 
            #            % (self.properties["Name"], command))
218
185
            self.update()
219
186
            return
220
187
        # Checker failed
221
 
        if not self.last_checker_failed:
222
 
            self.last_checker_failed = True
223
 
            self.using_timer(True)
224
188
        if os.WIFEXITED(condition):
225
 
            self.logger('Checker for client %s (command "%s")'
226
 
                        ' failed with exit code %s'
227
 
                        % (self.properties["Name"], command,
228
 
                           os.WEXITSTATUS(condition)))
 
189
            self.logger('Checker for client {0} (command "{1}")'
 
190
                        ' failed with exit code {2}'
 
191
                        .format(self.properties["Name"], command,
 
192
                                os.WEXITSTATUS(condition)))
229
193
        elif os.WIFSIGNALED(condition):
230
 
            self.logger('Checker for client %s (command "%s")'
231
 
                        ' was killed by signal %s'
232
 
                        % (self.properties["Name"], command,
233
 
                           os.WTERMSIG(condition)))
 
194
            self.logger('Checker for client {0} (command "{1}") was'
 
195
                        ' killed by signal {2}'
 
196
                        .format(self.properties["Name"], command,
 
197
                                os.WTERMSIG(condition)))
234
198
        elif os.WCOREDUMP(condition):
235
 
            self.logger('Checker for client %s (command "%s")'
 
199
            self.logger('Checker for client {0} (command "{1}")'
236
200
                        ' dumped core'
237
 
                        % (self.properties["Name"], command))
 
201
                        .format(self.properties["Name"], command))
238
202
        else:
239
 
            self.logger('Checker for client %s completed'
240
 
                        ' mysteriously')
 
203
            self.logger('Checker for client {0} completed'
 
204
                        ' mysteriously'
 
205
                        .format(self.properties["Name"]))
241
206
        self.update()
242
207
    
243
208
    def checker_started(self, command):
244
 
        #self.logger('Client %s started checker "%s"'
245
 
        #            % (self.properties["Name"], unicode(command)))
 
209
        """Server signals that a checker started. This could be useful
 
210
           to log in the future. """
 
211
        #self.logger('Client {0} started checker "{1}"'
 
212
        #            .format(self.properties["Name"],
 
213
        #                    unicode(command)))
246
214
        pass
247
215
    
248
216
    def got_secret(self):
249
 
        self.last_checker_failed = False
250
 
        self.logger('Client %s received its secret'
251
 
                    % self.properties["Name"])
 
217
        self.logger('Client {0} received its secret'
 
218
                    .format(self.properties["Name"]))
252
219
    
253
220
    def need_approval(self, timeout, default):
254
221
        if not default:
255
 
            message = 'Client %s needs approval within %s seconds'
 
222
            message = 'Client {0} needs approval within {1} seconds'
256
223
        else:
257
 
            message = 'Client %s will get its secret in %s seconds'
258
 
        self.logger(message
259
 
                    % (self.properties["Name"], timeout/1000))
260
 
        self.using_timer(True)
 
224
            message = 'Client {0} will get its secret in {1} seconds'
 
225
        self.logger(message.format(self.properties["Name"],
 
226
                                   timeout/1000))
261
227
    
262
228
    def rejected(self, reason):
263
 
        self.logger('Client %s was rejected; reason: %s'
264
 
                    % (self.properties["Name"], reason))
 
229
        self.logger('Client {0} was rejected; reason: {1}'
 
230
                    .format(self.properties["Name"], reason))
265
231
    
266
232
    def selectable(self):
267
233
        """Make this a "selectable" widget.
289
255
                          "bold-underline-blink":
290
256
                              "bold-underline-blink-standout",
291
257
                          }
292
 
 
 
258
        
293
259
        # Rebuild focus and non-focus widgets using current properties
294
 
 
 
260
        
295
261
        # Base part of a client. Name!
296
 
        base = ('%(name)s: '
297
 
                      % {"name": self.properties["Name"]})
 
262
        base = '{name}: '.format(name=self.properties["Name"])
298
263
        if not self.properties["Enabled"]:
299
264
            message = "DISABLED"
 
265
            self.using_timer(False)
300
266
        elif self.properties["ApprovalPending"]:
301
267
            timeout = datetime.timedelta(milliseconds
302
268
                                         = self.properties
304
270
            last_approval_request = isoformat_to_datetime(
305
271
                self.properties["LastApprovalRequest"])
306
272
            if last_approval_request is not None:
307
 
                timer = timeout - (datetime.datetime.utcnow()
308
 
                                   - last_approval_request)
 
273
                timer = max(timeout - (datetime.datetime.utcnow()
 
274
                                       - last_approval_request),
 
275
                            datetime.timedelta())
309
276
            else:
310
277
                timer = datetime.timedelta()
311
278
            if self.properties["ApprovedByDefault"]:
312
 
                message = "Approval in %s. (d)eny?"
313
 
            else:
314
 
                message = "Denial in %s. (a)pprove?"
315
 
            message = message % unicode(timer).rsplit(".", 1)[0]
316
 
        elif self.last_checker_failed:
317
 
            timeout = datetime.timedelta(milliseconds
318
 
                                         = self.properties
319
 
                                         ["Timeout"])
320
 
            last_ok = isoformat_to_datetime(
321
 
                max((self.properties["LastCheckedOK"]
322
 
                     or self.properties["Created"]),
323
 
                    self.properties["LastEnabled"]))
324
 
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
 
279
                message = "Approval in {0}. (d)eny?"
 
280
            else:
 
281
                message = "Denial in {0}. (a)pprove?"
 
282
            message = message.format(unicode(timer).rsplit(".", 1)[0])
 
283
            self.using_timer(True)
 
284
        elif self.properties["LastCheckerStatus"] != 0:
 
285
            # When checker has failed, show timer until client expires
 
286
            expires = self.properties["Expires"]
 
287
            if expires == "":
 
288
                timer = datetime.timedelta(0)
 
289
            else:
 
290
                expires = (datetime.datetime.strptime
 
291
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
 
292
                timer = max(expires - datetime.datetime.utcnow(),
 
293
                            datetime.timedelta())
325
294
            message = ('A checker has failed! Time until client'
326
 
                       ' gets disabled: %s'
327
 
                           % unicode(timer).rsplit(".", 1)[0])
 
295
                       ' gets disabled: {0}'
 
296
                       .format(unicode(timer).rsplit(".", 1)[0]))
 
297
            self.using_timer(True)
328
298
        else:
329
299
            message = "enabled"
330
 
        self._text = "%s%s" % (base, message)
331
 
            
 
300
            self.using_timer(False)
 
301
        self._text = "{0}{1}".format(base, message)
 
302
        
332
303
        if not urwid.supports_unicode():
333
304
            self._text = self._text.encode("ascii", "replace")
334
305
        textlist = [("normal", self._text)]
346
317
            self.update_hook()
347
318
    
348
319
    def update_timer(self):
349
 
        "called by gobject"
 
320
        """called by gobject. Will indefinitely loop until
 
321
        gobject.source_remove() on tag is called"""
350
322
        self.update()
351
323
        return True             # Keep calling this
352
324
    
353
 
    def delete(self, *args, **kwargs):
 
325
    def delete(self, **kwargs):
354
326
        if self._update_timer_callback_tag is not None:
355
327
            gobject.source_remove(self._update_timer_callback_tag)
356
328
            self._update_timer_callback_tag = None
359
331
        self.match_objects = ()
360
332
        if self.delete_hook is not None:
361
333
            self.delete_hook(self)
362
 
        return super(MandosClientWidget, self).delete(*args, **kwargs)
 
334
        return super(MandosClientWidget, self).delete(**kwargs)
363
335
    
364
336
    def render(self, maxcolrow, focus=False):
365
337
        """Render differently if we have focus.
407
379
        else:
408
380
            return key
409
381
    
410
 
    def property_changed(self, property=None, value=None,
411
 
                         *args, **kwargs):
 
382
    def property_changed(self, property=None, **kwargs):
412
383
        """Call self.update() if old value is not new value.
413
384
        This overrides the method from MandosClientPropertyCache"""
414
385
        property_name = unicode(property)
415
386
        old_value = self.properties.get(property_name)
416
387
        super(MandosClientWidget, self).property_changed(
417
 
            property=property, value=value, *args, **kwargs)
 
388
            property=property, **kwargs)
418
389
        if self.properties.get(property_name) != old_value:
419
390
            self.update()
420
391
 
424
395
    "down" key presses, thus not allowing any containing widgets to
425
396
    use them as an excuse to shift focus away from this widget.
426
397
    """
427
 
    def keypress(self, maxcolrow, key):
428
 
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
 
398
    def keypress(self, *args, **kwargs):
 
399
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
429
400
        if ret in ("up", "down"):
430
401
            return
431
402
        return ret
495
466
        
496
467
        self.busname = domain + '.Mandos'
497
468
        self.main_loop = gobject.MainLoop()
498
 
        self.bus = dbus.SystemBus()
499
 
        mandos_dbus_objc = self.bus.get_object(
500
 
            self.busname, "/", follow_name_owner_changes=True)
501
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
502
 
                                          dbus_interface
503
 
                                          = server_interface)
504
 
        try:
505
 
            mandos_clients = (self.mandos_serv
506
 
                              .GetAllClientsWithProperties())
507
 
        except dbus.exceptions.DBusException:
508
 
            mandos_clients = dbus.Dictionary()
509
 
        
510
 
        (self.mandos_serv
511
 
         .connect_to_signal("ClientRemoved",
512
 
                            self.find_and_remove_client,
513
 
                            dbus_interface=server_interface,
514
 
                            byte_arrays=True))
515
 
        (self.mandos_serv
516
 
         .connect_to_signal("ClientAdded",
517
 
                            self.add_new_client,
518
 
                            dbus_interface=server_interface,
519
 
                            byte_arrays=True))
520
 
        (self.mandos_serv
521
 
         .connect_to_signal("ClientNotFound",
522
 
                            self.client_not_found,
523
 
                            dbus_interface=server_interface,
524
 
                            byte_arrays=True))
525
 
        for path, client in mandos_clients.iteritems():
526
 
            client_proxy_object = self.bus.get_object(self.busname,
527
 
                                                      path)
528
 
            self.add_client(MandosClientWidget(server_proxy_object
529
 
                                               =self.mandos_serv,
530
 
                                               proxy_object
531
 
                                               =client_proxy_object,
532
 
                                               properties=client,
533
 
                                               update_hook
534
 
                                               =self.refresh,
535
 
                                               delete_hook
536
 
                                               =self.remove_client,
537
 
                                               logger
538
 
                                               =self.log_message),
539
 
                            path=path)
540
469
    
541
470
    def client_not_found(self, fingerprint, address):
542
 
        self.log_message(("Client with address %s and fingerprint %s"
543
 
                          " could not be found" % (address,
544
 
                                                    fingerprint)))
 
471
        self.log_message("Client with address {0} and fingerprint"
 
472
                         " {1} could not be found"
 
473
                         .format(address, fingerprint))
545
474
    
546
475
    def rebuild(self):
547
476
        """This rebuilds the User Interface.
557
486
                                                     self.divider)))
558
487
        if self.log_visible:
559
488
            self.uilist.append(self.logbox)
560
 
            pass
561
489
        self.topwidget = urwid.Pile(self.uilist)
562
490
    
563
491
    def log_message(self, message):
601
529
            client = self.clients_dict[path]
602
530
        except KeyError:
603
531
            # not found?
604
 
            self.log_message("Unknown client %r (%r) removed", name,
605
 
                             path)
 
532
            self.log_message("Unknown client {0!r} ({1!r}) removed"
 
533
                             .format(name, path))
606
534
            return
607
535
        client.delete()
608
536
    
647
575
    
648
576
    def run(self):
649
577
        """Start the main loop and exit when it's done."""
 
578
        self.bus = dbus.SystemBus()
 
579
        mandos_dbus_objc = self.bus.get_object(
 
580
            self.busname, "/", follow_name_owner_changes=True)
 
581
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
582
                                          dbus_interface
 
583
                                          = server_interface)
 
584
        try:
 
585
            mandos_clients = (self.mandos_serv
 
586
                              .GetAllClientsWithProperties())
 
587
        except dbus.exceptions.DBusException:
 
588
            mandos_clients = dbus.Dictionary()
 
589
        
 
590
        (self.mandos_serv
 
591
         .connect_to_signal("ClientRemoved",
 
592
                            self.find_and_remove_client,
 
593
                            dbus_interface=server_interface,
 
594
                            byte_arrays=True))
 
595
        (self.mandos_serv
 
596
         .connect_to_signal("ClientAdded",
 
597
                            self.add_new_client,
 
598
                            dbus_interface=server_interface,
 
599
                            byte_arrays=True))
 
600
        (self.mandos_serv
 
601
         .connect_to_signal("ClientNotFound",
 
602
                            self.client_not_found,
 
603
                            dbus_interface=server_interface,
 
604
                            byte_arrays=True))
 
605
        for path, client in mandos_clients.iteritems():
 
606
            client_proxy_object = self.bus.get_object(self.busname,
 
607
                                                      path)
 
608
            self.add_client(MandosClientWidget(server_proxy_object
 
609
                                               =self.mandos_serv,
 
610
                                               proxy_object
 
611
                                               =client_proxy_object,
 
612
                                               properties=client,
 
613
                                               update_hook
 
614
                                               =self.refresh,
 
615
                                               delete_hook
 
616
                                               =self.remove_client,
 
617
                                               logger
 
618
                                               =self.log_message),
 
619
                            path=path)
 
620
        
650
621
        self.refresh()
651
622
        self._input_callback_tag = (gobject.io_add_watch
652
623
                                    (sys.stdin.fileno(),