/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-05-22 20:00:18 UTC
  • Revision ID: teddy@recompile.se-20130522200018-xtbddz21pl7c69kw
* mandos: Bug fix: Don't print output from checkers when running in
          foreground.
          Bug fix: Do not fail when client is removed from
          clients.conf but saved settings remain.
  (Client.server_settings): New attribute.
  (Client.__init__): Take new "server_settings" keyword argument.  All
                     callers changed.
  (Client.start_checker): Redirect stdout and stderr for checkers when
                          running in foreground.
  (main): New "wnull" global variable for a writable /dev/null file.
          Do not restore settings for clients no longer in config file.
  (main/cleanup): Close wnull file object.  Do not save client
                  attribute "server_settings"
* mandos-monitor: Update to work in Urwid 1.0.1.
                  Adapt to work in both Python 3 and Python 2.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-monitor
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
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)
 
28
try:
 
29
    from future_builtins import *
 
30
except ImportError:
 
31
    pass
27
32
 
28
33
import sys
29
34
import os
35
40
import urwid
36
41
 
37
42
from dbus.mainloop.glib import DBusGMainLoop
38
 
import gobject
 
43
try:
 
44
    import gobject
 
45
except ImportError:
 
46
    from gi.repository import GObject as gobject
39
47
 
40
48
import dbus
41
49
 
42
 
import UserList
43
 
 
44
50
import locale
45
51
 
 
52
if sys.version_info[0] == 2:
 
53
    str = unicode
 
54
 
46
55
locale.setlocale(locale.LC_ALL, '')
47
56
 
48
57
import logging
52
61
domain = 'se.recompile'
53
62
server_interface = domain + '.Mandos'
54
63
client_interface = domain + '.Mandos.Client'
55
 
version = "1.4.1"
56
 
 
57
 
# Always run in monochrome mode
58
 
urwid.curses_display.curses.has_colors = lambda : False
59
 
 
60
 
# Urwid doesn't support blinking, but we want it.  Since we have no
61
 
# use for underline on its own, we make underline also always blink.
62
 
urwid.curses_display.curses.A_UNDERLINE |= (
63
 
    urwid.curses_display.curses.A_BLINK)
 
64
version = "1.6.0"
64
65
 
65
66
def isoformat_to_datetime(iso):
66
67
    "Parse an ISO 8601 date string to a datetime.datetime()"
83
84
    properties and calls a hook function when any of them are
84
85
    changed.
85
86
    """
86
 
    def __init__(self, proxy_object=None, *args, **kwargs):
 
87
    def __init__(self, proxy_object=None, properties=None, **kwargs):
87
88
        self.proxy = proxy_object # Mandos Client proxy object
88
 
        
89
 
        self.properties = dict()
 
89
        self.properties = dict() if properties is None else properties
90
90
        self.property_changed_match = (
91
91
            self.proxy.connect_to_signal("PropertyChanged",
92
 
                                         self.property_changed,
 
92
                                         self._property_changed,
93
93
                                         client_interface,
94
94
                                         byte_arrays=True))
95
95
        
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)
 
96
        if properties is None:
 
97
            self.properties.update(
 
98
                self.proxy.GetAll(client_interface,
 
99
                                  dbus_interface
 
100
                                  = dbus.PROPERTIES_IFACE))
 
101
        
 
102
        super(MandosClientPropertyCache, self).__init__(**kwargs)
 
103
    
 
104
    def _property_changed(self, property, value):
 
105
        """Helper which takes positional arguments"""
 
106
        return self.property_changed(property=property, value=value)
103
107
    
104
108
    def property_changed(self, property=None, value=None):
105
109
        """This is called whenever we get a PropertyChanged signal
108
112
        # Update properties dict with new value
109
113
        self.properties[property] = value
110
114
    
111
 
    def delete(self, *args, **kwargs):
 
115
    def delete(self):
112
116
        self.property_changed_match.remove()
113
 
        super(MandosClientPropertyCache, self).__init__(
114
 
            *args, **kwargs)
115
117
 
116
118
 
117
119
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
119
121
    """
120
122
    
121
123
    def __init__(self, server_proxy_object=None, update_hook=None,
122
 
                 delete_hook=None, logger=None, *args, **kwargs):
 
124
                 delete_hook=None, logger=None, **kwargs):
123
125
        # Called on update
124
126
        self.update_hook = update_hook
125
127
        # Called on delete
130
132
        self.logger = logger
131
133
        
132
134
        self._update_timer_callback_tag = None
133
 
        self._update_timer_callback_lock = 0
134
 
        self.last_checker_failed = False
135
135
        
136
136
        # The widget shown normally
137
137
        self._text_widget = urwid.Text("")
138
138
        # The widget shown when we have focus
139
139
        self._focus_text_widget = urwid.Text("")
140
 
        super(MandosClientWidget, self).__init__(
141
 
            update_hook=update_hook, delete_hook=delete_hook,
142
 
            *args, **kwargs)
 
140
        super(MandosClientWidget, self).__init__(**kwargs)
143
141
        self.update()
144
142
        self.opened = False
145
143
        
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
144
        self.match_objects = (
165
145
            self.proxy.connect_to_signal("CheckerCompleted",
166
146
                                         self.checker_completed,
182
162
                                         self.rejected,
183
163
                                         client_interface,
184
164
                                         byte_arrays=True))
185
 
        #self.logger('Created client %s' % (self.properties["Name"]))
 
165
        #self.logger('Created client {0}'
 
166
        #            .format(self.properties["Name"]))
186
167
    
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
168
    def using_timer(self, flag):
194
169
        """Call this method with True or False when timer should be
195
170
        activated or deactivated.
196
171
        """
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:
 
172
        if flag and self._update_timer_callback_tag is None:
203
173
            # Will update the shown timer value every second
204
174
            self._update_timer_callback_tag = (gobject.timeout_add
205
175
                                               (1000,
206
176
                                                self.update_timer))
207
 
        elif old and self._update_timer_callback_lock == 0:
 
177
        elif not (flag or self._update_timer_callback_tag is None):
208
178
            gobject.source_remove(self._update_timer_callback_tag)
209
179
            self._update_timer_callback_tag = None
210
180
    
211
181
    def checker_completed(self, exitstatus, condition, command):
212
182
        if exitstatus == 0:
213
 
            if self.last_checker_failed:
214
 
                self.last_checker_failed = False
215
 
                self.using_timer(False)
216
 
            #self.logger('Checker for client %s (command "%s")'
217
 
            #            ' was successful'
218
 
            #            % (self.properties["Name"], command))
219
183
            self.update()
220
184
            return
221
185
        # Checker failed
222
 
        if not self.last_checker_failed:
223
 
            self.last_checker_failed = True
224
 
            self.using_timer(True)
225
186
        if os.WIFEXITED(condition):
226
 
            self.logger('Checker for client %s (command "%s")'
227
 
                        ' failed with exit code %s'
228
 
                        % (self.properties["Name"], command,
229
 
                           os.WEXITSTATUS(condition)))
 
187
            self.logger('Checker for client {0} (command "{1}")'
 
188
                        ' failed with exit code {2}'
 
189
                        .format(self.properties["Name"], command,
 
190
                                os.WEXITSTATUS(condition)))
230
191
        elif os.WIFSIGNALED(condition):
231
 
            self.logger('Checker for client %s (command "%s")'
232
 
                        ' was killed by signal %s'
233
 
                        % (self.properties["Name"], command,
234
 
                           os.WTERMSIG(condition)))
 
192
            self.logger('Checker for client {0} (command "{1}") was'
 
193
                        ' killed by signal {2}'
 
194
                        .format(self.properties["Name"], command,
 
195
                                os.WTERMSIG(condition)))
235
196
        elif os.WCOREDUMP(condition):
236
 
            self.logger('Checker for client %s (command "%s")'
 
197
            self.logger('Checker for client {0} (command "{1}")'
237
198
                        ' dumped core'
238
 
                        % (self.properties["Name"], command))
 
199
                        .format(self.properties["Name"], command))
239
200
        else:
240
 
            self.logger('Checker for client %s completed'
241
 
                        ' mysteriously')
 
201
            self.logger('Checker for client {0} completed'
 
202
                        ' mysteriously'
 
203
                        .format(self.properties["Name"]))
242
204
        self.update()
243
205
    
244
206
    def checker_started(self, command):
245
207
        """Server signals that a checker started. This could be useful
246
208
           to log in the future. """
247
 
        #self.logger('Client %s started checker "%s"'
248
 
        #            % (self.properties["Name"], unicode(command)))
 
209
        #self.logger('Client {0} started checker "{1}"'
 
210
        #            .format(self.properties["Name"],
 
211
        #                    str(command)))
249
212
        pass
250
213
    
251
214
    def got_secret(self):
252
 
        self.last_checker_failed = False
253
 
        self.logger('Client %s received its secret'
254
 
                    % self.properties["Name"])
 
215
        self.logger('Client {0} received its secret'
 
216
                    .format(self.properties["Name"]))
255
217
    
256
218
    def need_approval(self, timeout, default):
257
219
        if not default:
258
 
            message = 'Client %s needs approval within %s seconds'
 
220
            message = 'Client {0} needs approval within {1} seconds'
259
221
        else:
260
 
            message = 'Client %s will get its secret in %s seconds'
261
 
        self.logger(message
262
 
                    % (self.properties["Name"], timeout/1000))
263
 
        self.using_timer(True)
 
222
            message = 'Client {0} will get its secret in {1} seconds'
 
223
        self.logger(message.format(self.properties["Name"],
 
224
                                   timeout/1000))
264
225
    
265
226
    def rejected(self, reason):
266
 
        self.logger('Client %s was rejected; reason: %s'
267
 
                    % (self.properties["Name"], reason))
 
227
        self.logger('Client {0} was rejected; reason: {1}'
 
228
                    .format(self.properties["Name"], reason))
268
229
    
269
230
    def selectable(self):
270
231
        """Make this a "selectable" widget.
292
253
                          "bold-underline-blink":
293
254
                              "bold-underline-blink-standout",
294
255
                          }
295
 
 
 
256
        
296
257
        # Rebuild focus and non-focus widgets using current properties
297
 
 
 
258
        
298
259
        # Base part of a client. Name!
299
 
        base = ('%(name)s: '
300
 
                      % {"name": self.properties["Name"]})
 
260
        base = '{name}: '.format(name=self.properties["Name"])
301
261
        if not self.properties["Enabled"]:
302
262
            message = "DISABLED"
 
263
            self.using_timer(False)
303
264
        elif self.properties["ApprovalPending"]:
304
265
            timeout = datetime.timedelta(milliseconds
305
266
                                         = self.properties
307
268
            last_approval_request = isoformat_to_datetime(
308
269
                self.properties["LastApprovalRequest"])
309
270
            if last_approval_request is not None:
310
 
                timer = timeout - (datetime.datetime.utcnow()
311
 
                                   - last_approval_request)
 
271
                timer = max(timeout - (datetime.datetime.utcnow()
 
272
                                       - last_approval_request),
 
273
                            datetime.timedelta())
312
274
            else:
313
275
                timer = datetime.timedelta()
314
276
            if self.properties["ApprovedByDefault"]:
315
 
                message = "Approval in %s. (d)eny?"
 
277
                message = "Approval in {0}. (d)eny?"
316
278
            else:
317
 
                message = "Denial in %s. (a)pprove?"
318
 
            message = message % unicode(timer).rsplit(".", 1)[0]
319
 
        elif self.last_checker_failed:
320
 
            # When checker has failed, print a timer until client expires
 
279
                message = "Denial in {0}. (a)pprove?"
 
280
            message = message.format(str(timer).rsplit(".", 1)[0])
 
281
            self.using_timer(True)
 
282
        elif self.properties["LastCheckerStatus"] != 0:
 
283
            # When checker has failed, show timer until client expires
321
284
            expires = self.properties["Expires"]
322
285
            if expires == "":
323
286
                timer = datetime.timedelta(0)
324
287
            else:
325
 
                expires = datetime.datetime.strptime(expires,
326
 
                                                     '%Y-%m-%dT%H:%M:%S.%f')
327
 
                timer = expires - datetime.datetime.utcnow()
 
288
                expires = (datetime.datetime.strptime
 
289
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
 
290
                timer = max(expires - datetime.datetime.utcnow(),
 
291
                            datetime.timedelta())
328
292
            message = ('A checker has failed! Time until client'
329
 
                       ' gets disabled: %s'
330
 
                           % unicode(timer).rsplit(".", 1)[0])
 
293
                       ' gets disabled: {0}'
 
294
                       .format(str(timer).rsplit(".", 1)[0]))
 
295
            self.using_timer(True)
331
296
        else:
332
297
            message = "enabled"
333
 
        self._text = "%s%s" % (base, message)
334
 
            
 
298
            self.using_timer(False)
 
299
        self._text = "{0}{1}".format(base, message)
 
300
        
335
301
        if not urwid.supports_unicode():
336
302
            self._text = self._text.encode("ascii", "replace")
337
303
        textlist = [("normal", self._text)]
354
320
        self.update()
355
321
        return True             # Keep calling this
356
322
    
357
 
    def delete(self, *args, **kwargs):
 
323
    def delete(self, **kwargs):
358
324
        if self._update_timer_callback_tag is not None:
359
325
            gobject.source_remove(self._update_timer_callback_tag)
360
326
            self._update_timer_callback_tag = None
363
329
        self.match_objects = ()
364
330
        if self.delete_hook is not None:
365
331
            self.delete_hook(self)
366
 
        return super(MandosClientWidget, self).delete(*args, **kwargs)
 
332
        return super(MandosClientWidget, self).delete(**kwargs)
367
333
    
368
334
    def render(self, maxcolrow, focus=False):
369
335
        """Render differently if we have focus.
411
377
        else:
412
378
            return key
413
379
    
414
 
    def property_changed(self, property=None, value=None,
415
 
                         *args, **kwargs):
 
380
    def property_changed(self, property=None, **kwargs):
416
381
        """Call self.update() if old value is not new value.
417
382
        This overrides the method from MandosClientPropertyCache"""
418
 
        property_name = unicode(property)
 
383
        property_name = str(property)
419
384
        old_value = self.properties.get(property_name)
420
385
        super(MandosClientWidget, self).property_changed(
421
 
            property=property, value=value, *args, **kwargs)
 
386
            property=property, **kwargs)
422
387
        if self.properties.get(property_name) != old_value:
423
388
            self.update()
424
389
 
428
393
    "down" key presses, thus not allowing any containing widgets to
429
394
    use them as an excuse to shift focus away from this widget.
430
395
    """
431
 
    def keypress(self, maxcolrow, key):
432
 
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
 
396
    def keypress(self, *args, **kwargs):
 
397
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
433
398
        if ret in ("up", "down"):
434
399
            return
435
400
        return ret
448
413
                ("normal",
449
414
                 "default", "default", None),
450
415
                ("bold",
451
 
                 "default", "default", "bold"),
 
416
                 "bold", "default", "bold"),
452
417
                ("underline-blink",
453
 
                 "default", "default", "underline"),
 
418
                 "underline,blink", "default", "underline,blink"),
454
419
                ("standout",
455
 
                 "default", "default", "standout"),
 
420
                 "standout", "default", "standout"),
456
421
                ("bold-underline-blink",
457
 
                 "default", "default", ("bold", "underline")),
 
422
                 "bold,underline,blink", "default", "bold,underline,blink"),
458
423
                ("bold-standout",
459
 
                 "default", "default", ("bold", "standout")),
 
424
                 "bold,standout", "default", "bold,standout"),
460
425
                ("underline-blink-standout",
461
 
                 "default", "default", ("underline", "standout")),
 
426
                 "underline,blink,standout", "default",
 
427
                 "underline,blink,standout"),
462
428
                ("bold-underline-blink-standout",
463
 
                 "default", "default", ("bold", "underline",
464
 
                                          "standout")),
 
429
                 "bold,underline,blink,standout", "default",
 
430
                 "bold,underline,blink,standout"),
465
431
                ))
466
432
        
467
433
        if urwid.supports_unicode():
501
467
        self.main_loop = gobject.MainLoop()
502
468
    
503
469
    def client_not_found(self, fingerprint, address):
504
 
        self.log_message(("Client with address %s and fingerprint %s"
505
 
                          " could not be found" % (address,
506
 
                                                    fingerprint)))
 
470
        self.log_message("Client with address {0} and fingerprint"
 
471
                         " {1} could not be found"
 
472
                         .format(address, fingerprint))
507
473
    
508
474
    def rebuild(self):
509
475
        """This rebuilds the User Interface.
522
488
        self.topwidget = urwid.Pile(self.uilist)
523
489
    
524
490
    def log_message(self, message):
 
491
        """Log message formatted with timestamp"""
525
492
        timestamp = datetime.datetime.now().isoformat()
526
493
        self.log_message_raw(timestamp + ": " + message)
527
494
    
540
507
        self.log_visible = not self.log_visible
541
508
        self.rebuild()
542
509
        #self.log_message("Log visibility changed to: "
543
 
        #                 + unicode(self.log_visible))
 
510
        #                 + str(self.log_visible))
544
511
    
545
512
    def change_log_display(self):
546
513
        """Change type of log display.
562
529
            client = self.clients_dict[path]
563
530
        except KeyError:
564
531
            # not found?
565
 
            self.log_message("Unknown client %r (%r) removed", name,
566
 
                             path)
 
532
            self.log_message("Unknown client {0!r} ({1!r}) removed"
 
533
                             .format(name, path))
567
534
            return
568
535
        client.delete()
569
536
    
586
553
        if path is None:
587
554
            path = client.proxy.object_path
588
555
        self.clients_dict[path] = client
589
 
        self.clients.sort(None, lambda c: c.properties["Name"])
 
556
        self.clients.sort(key=lambda c: c.properties["Name"])
590
557
        self.refresh()
591
558
    
592
559
    def remove_client(self, client, path=None):
594
561
        if path is None:
595
562
            path = client.proxy.object_path
596
563
        del self.clients_dict[path]
597
 
        if not self.clients_dict:
598
 
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
599
 
            # is completely emptied, we need to recreate it.
600
 
            self.clients = urwid.SimpleListWalker([])
601
 
            self.rebuild()
602
564
        self.refresh()
603
565
    
604
566
    def refresh(self):
617
579
        try:
618
580
            mandos_clients = (self.mandos_serv
619
581
                              .GetAllClientsWithProperties())
 
582
            if not mandos_clients:
 
583
                self.log_message_raw(("bold", "Note: Server has no clients."))
620
584
        except dbus.exceptions.DBusException:
 
585
            self.log_message_raw(("bold", "Note: No Mandos server running."))
621
586
            mandos_clients = dbus.Dictionary()
622
587
        
623
588
        (self.mandos_serv
635
600
                            self.client_not_found,
636
601
                            dbus_interface=server_interface,
637
602
                            byte_arrays=True))
638
 
        for path, client in mandos_clients.iteritems():
 
603
        for path, client in mandos_clients.items():
639
604
            client_proxy_object = self.bus.get_object(self.busname,
640
605
                                                      path)
641
606
            self.add_client(MandosClientWidget(server_proxy_object
650
615
                                               logger
651
616
                                               =self.log_message),
652
617
                            path=path)
653
 
 
 
618
        
654
619
        self.refresh()
655
620
        self._input_callback_tag = (gobject.io_add_watch
656
621
                                    (sys.stdin.fileno(),
753
718
    ui.run()
754
719
except KeyboardInterrupt:
755
720
    ui.screen.stop()
756
 
except Exception, e:
757
 
    ui.log_message(unicode(e))
 
721
except Exception as e:
 
722
    ui.log_message(str(e))
758
723
    ui.screen.stop()
759
724
    raise