/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: teddy at bsnet
  • Date: 2011-02-11 18:54:14 UTC
  • mto: (237.7.13 mandos)
  • mto: This revision was merged to the branch mainline in revision 282.
  • Revision ID: teddy@fukt.bsnet.se-20110211185414-cjmw3hppv9i3h9wh
* mandos-monitor: Use only unicode string literals.
  (MandosClientWidget.rows, MandosClientWidget.render,
  MandosClientWidget.keypress, ConstrainedListBox.keypress) Don't use
                                                            argument
                                                            tuple
                                                            unpacking.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-monitor
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
 
3
# 
 
4
# Mandos Monitor - Control and monitor the Mandos server
 
5
# 
 
6
# Copyright © 2009,2010 Teddy Hogeborn
 
7
# Copyright © 2009,2010 Björn Påhlsson
 
8
# 
 
9
# This program is free software: you can redistribute it and/or modify
 
10
# it under the terms of the GNU General Public License as published by
 
11
# the Free Software Foundation, either version 3 of the License, or
 
12
# (at your option) any later version.
 
13
#
 
14
#     This program is distributed in the hope that it will be useful,
 
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
17
#     GNU General Public License for more details.
 
18
# 
 
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/>.
 
21
# 
 
22
# Contact the authors at <mandos@fukt.bsnet.se>.
 
23
# 
3
24
 
4
25
from __future__ import division, absolute_import, with_statement
5
26
 
19
40
 
20
41
import UserList
21
42
 
 
43
import locale
 
44
 
 
45
locale.setlocale(locale.LC_ALL, u'')
 
46
 
 
47
import logging
 
48
logging.getLogger(u'dbus.proxies').setLevel(logging.CRITICAL)
 
49
 
22
50
# Some useful constants
23
 
domain = 'se.bsnet.fukt'
24
 
server_interface = domain + '.Mandos'
25
 
client_interface = domain + '.Mandos.Client'
26
 
version = "1.0.14"
 
51
domain = u'se.bsnet.fukt'
 
52
server_interface = domain + u'.Mandos'
 
53
client_interface = domain + u'.Mandos.Client'
 
54
version = u"1.2.3"
27
55
 
28
56
# Always run in monochrome mode
29
57
urwid.curses_display.curses.has_colors = lambda : False
33
61
urwid.curses_display.curses.A_UNDERLINE |= (
34
62
    urwid.curses_display.curses.A_BLINK)
35
63
 
 
64
def isoformat_to_datetime(iso):
 
65
    "Parse an ISO 8601 date string to a datetime.datetime()"
 
66
    if not iso:
 
67
        return None
 
68
    d, t = iso.split(u"T", 1)
 
69
    year, month, day = d.split(u"-", 2)
 
70
    hour, minute, second = t.split(u":", 2)
 
71
    second, fraction = divmod(float(second), 1)
 
72
    return datetime.datetime(int(year),
 
73
                             int(month),
 
74
                             int(day),
 
75
                             int(hour),
 
76
                             int(minute),
 
77
                             int(second),           # Whole seconds
 
78
                             int(fraction*1000000)) # Microseconds
 
79
 
36
80
class MandosClientPropertyCache(object):
37
81
    """This wraps a Mandos Client D-Bus proxy object, caches the
38
82
    properties and calls a hook function when any of them are
39
83
    changed.
40
84
    """
41
 
    def __init__(self, proxy_object=None, properties=None, *args,
42
 
                 **kwargs):
 
85
    def __init__(self, proxy_object=None, *args, **kwargs):
43
86
        self.proxy = proxy_object # Mandos Client proxy object
44
87
        
45
 
        if properties is None:
46
 
            self.properties = dict()
47
 
        else:
48
 
            self.properties = properties
 
88
        self.properties = dict()
49
89
        self.proxy.connect_to_signal(u"PropertyChanged",
50
90
                                     self.property_changed,
51
91
                                     client_interface,
52
92
                                     byte_arrays=True)
53
93
        
54
 
        if properties is None:
55
 
            self.properties.update(self.proxy.GetAll(client_interface,
56
 
                                                     dbus_interface =
57
 
                                                     dbus.PROPERTIES_IFACE))
58
 
        super(MandosClientPropertyCache, self).__init__(
59
 
            proxy_object=proxy_object,
60
 
            properties=properties, *args, **kwargs)
 
94
        self.properties.update(
 
95
            self.proxy.GetAll(client_interface,
 
96
                              dbus_interface = dbus.PROPERTIES_IFACE))
 
97
 
 
98
        #XXX This break good super behaviour!
 
99
#        super(MandosClientPropertyCache, self).__init__(
 
100
#            *args, **kwargs)
61
101
    
62
102
    def property_changed(self, property=None, value=None):
63
103
        """This is called whenever we get a PropertyChanged signal
82
122
        # Logger
83
123
        self.logger = logger
84
124
        
 
125
        self._update_timer_callback_tag = None
 
126
        self._update_timer_callback_lock = 0
 
127
        self.last_checker_failed = False
 
128
        
85
129
        # The widget shown normally
86
130
        self._text_widget = urwid.Text(u"")
87
131
        # The widget shown when we have focus
91
135
            *args, **kwargs)
92
136
        self.update()
93
137
        self.opened = False
 
138
        
 
139
        last_checked_ok = isoformat_to_datetime(self.properties
 
140
                                                [u"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
                                         [u"Interval"]))
 
150
        
 
151
        if self.last_checker_failed:
 
152
            self.using_timer(True)
 
153
        
 
154
        if self.need_approval:
 
155
            self.using_timer(True)
 
156
        
94
157
        self.proxy.connect_to_signal(u"CheckerCompleted",
95
158
                                     self.checker_completed,
96
159
                                     client_interface,
103
166
                                     self.got_secret,
104
167
                                     client_interface,
105
168
                                     byte_arrays=True)
 
169
        self.proxy.connect_to_signal(u"NeedApproval",
 
170
                                     self.need_approval,
 
171
                                     client_interface,
 
172
                                     byte_arrays=True)
106
173
        self.proxy.connect_to_signal(u"Rejected",
107
174
                                     self.rejected,
108
175
                                     client_interface,
109
176
                                     byte_arrays=True)
110
177
    
 
178
    def property_changed(self, property=None, value=None):
 
179
        super(self, MandosClientWidget).property_changed(property,
 
180
                                                         value)
 
181
        if property == u"ApprovalPending":
 
182
            using_timer(bool(value))
 
183
        
 
184
    def using_timer(self, flag):
 
185
        """Call this method with True or False when timer should be
 
186
        activated or deactivated.
 
187
        """
 
188
        old = self._update_timer_callback_lock
 
189
        if flag:
 
190
            self._update_timer_callback_lock += 1
 
191
        else:
 
192
            self._update_timer_callback_lock -= 1
 
193
        if old == 0 and self._update_timer_callback_lock:
 
194
            self._update_timer_callback_tag = (gobject.timeout_add
 
195
                                               (1000,
 
196
                                                self.update_timer))
 
197
        elif old and self._update_timer_callback_lock == 0:
 
198
            gobject.source_remove(self._update_timer_callback_tag)
 
199
            self._update_timer_callback_tag = None
 
200
    
111
201
    def checker_completed(self, exitstatus, condition, command):
112
202
        if exitstatus == 0:
113
 
            self.logger(u'Checker for client %s (command "%s")'
114
 
                        u' was successful'
115
 
                        % (self.properties[u"name"], command))
 
203
            if self.last_checker_failed:
 
204
                self.last_checker_failed = False
 
205
                self.using_timer(False)
 
206
            #self.logger(u'Checker for client %s (command "%s")'
 
207
            #            u' was successful'
 
208
            #            % (self.properties[u"Name"], command))
 
209
            self.update()
116
210
            return
 
211
        # Checker failed
 
212
        if not self.last_checker_failed:
 
213
            self.last_checker_failed = True
 
214
            self.using_timer(True)
117
215
        if os.WIFEXITED(condition):
118
216
            self.logger(u'Checker for client %s (command "%s")'
119
217
                        u' failed with exit code %s'
120
 
                        % (self.properties[u"name"], command,
 
218
                        % (self.properties[u"Name"], command,
121
219
                           os.WEXITSTATUS(condition)))
122
 
            return
123
 
        if os.WIFSIGNALED(condition):
 
220
        elif os.WIFSIGNALED(condition):
124
221
            self.logger(u'Checker for client %s (command "%s")'
125
222
                        u' was killed by signal %s'
126
 
                        % (self.properties[u"name"], command,
 
223
                        % (self.properties[u"Name"], command,
127
224
                           os.WTERMSIG(condition)))
128
 
            return
129
 
        if os.WCOREDUMP(condition):
 
225
        elif os.WCOREDUMP(condition):
130
226
            self.logger(u'Checker for client %s (command "%s")'
131
227
                        u' dumped core'
132
 
                        % (self.properties[u"name"], command))
133
 
        self.logger(u'Checker for client %s completed mysteriously')
 
228
                        % (self.properties[u"Name"], command))
 
229
        else:
 
230
            self.logger(u'Checker for client %s completed'
 
231
                        u' mysteriously')
 
232
        self.update()
134
233
    
135
234
    def checker_started(self, command):
136
 
        self.logger(u'Client %s started checker "%s"'
137
 
                    % (self.properties[u"name"], unicode(command)))
 
235
        #self.logger(u'Client %s started checker "%s"'
 
236
        #            % (self.properties[u"Name"], unicode(command)))
 
237
        pass
138
238
    
139
239
    def got_secret(self):
 
240
        self.last_checker_failed = False
140
241
        self.logger(u'Client %s received its secret'
141
 
                    % self.properties[u"name"])
142
 
    
143
 
    def rejected(self):
144
 
        self.logger(u'Client %s was rejected'
145
 
                    % self.properties[u"name"])
 
242
                    % self.properties[u"Name"])
 
243
    
 
244
    def need_approval(self, timeout, default):
 
245
        if not default:
 
246
            message = u'Client %s needs approval within %s seconds'
 
247
        else:
 
248
            message = u'Client %s will get its secret in %s seconds'
 
249
        self.logger(message
 
250
                    % (self.properties[u"Name"], timeout/1000))
 
251
        self.using_timer(True)
 
252
    
 
253
    def rejected(self, reason):
 
254
        self.logger(u'Client %s was rejected; reason: %s'
 
255
                    % (self.properties[u"Name"], reason))
146
256
    
147
257
    def selectable(self):
148
258
        """Make this a "selectable" widget.
149
259
        This overrides the method from urwid.FlowWidget."""
150
260
        return True
151
261
    
152
 
    def rows(self, (maxcol,), focus=False):
 
262
    def rows(self, maxcolrow, focus=False):
153
263
        """How many rows this widget will occupy might depend on
154
264
        whether we have focus or not.
155
265
        This overrides the method from urwid.FlowWidget"""
156
 
        return self.current_widget(focus).rows((maxcol,), focus=focus)
 
266
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
157
267
    
158
268
    def current_widget(self, focus=False):
159
269
        if focus or self.opened:
170
280
                          u"bold-underline-blink":
171
281
                              u"bold-underline-blink-standout",
172
282
                          }
173
 
        
 
283
 
174
284
        # Rebuild focus and non-focus widgets using current properties
175
 
        self._text = (u'%(name)s: %(enabled)s'
176
 
                      % { u"name": self.properties[u"name"],
177
 
                          u"enabled":
178
 
                              (u"enabled"
179
 
                               if self.properties[u"enabled"]
180
 
                               else u"DISABLED")})
 
285
 
 
286
        # Base part of a client. Name!
 
287
        base = (u'%(name)s: '
 
288
                      % {u"name": self.properties[u"Name"]})
 
289
        if not self.properties[u"Enabled"]:
 
290
            message = u"DISABLED"
 
291
        elif self.properties[u"ApprovalPending"]:
 
292
            timeout = datetime.timedelta(milliseconds
 
293
                                         = self.properties
 
294
                                         [u"ApprovalDelay"])
 
295
            last_approval_request = isoformat_to_datetime(
 
296
                self.properties[u"LastApprovalRequest"])
 
297
            if last_approval_request is not None:
 
298
                timer = timeout - (datetime.datetime.utcnow()
 
299
                                   - last_approval_request)
 
300
            else:
 
301
                timer = datetime.timedelta()
 
302
            if self.properties[u"ApprovedByDefault"]:
 
303
                message = u"Approval in %s. (d)eny?"
 
304
            else:
 
305
                message = u"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
                                         [u"Timeout"])
 
311
            last_ok = isoformat_to_datetime(
 
312
                max((self.properties[u"LastCheckedOK"]
 
313
                     or self.properties[u"Created"]),
 
314
                    self.properties[u"LastEnabled"]))
 
315
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
 
316
            message = (u'A checker has failed! Time until client'
 
317
                       u' gets disabled: %s'
 
318
                           % unicode(timer).rsplit(".", 1)[0])
 
319
        else:
 
320
            message = u"enabled"
 
321
        self._text = u"%s%s" % (base, message)
 
322
            
181
323
        if not urwid.supports_unicode():
182
 
            self._text = self._text.encode("ascii", "replace")
 
324
            self._text = self._text.encode(u"ascii", u"replace")
183
325
        textlist = [(u"normal", self._text)]
184
326
        self._text_widget.set_text(textlist)
185
327
        self._focus_text_widget.set_text([(with_standout[text[0]],
189
331
                                          for text in textlist])
190
332
        self._widget = self._text_widget
191
333
        self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
192
 
                                            "standout")
 
334
                                            u"standout")
193
335
        # Run update hook, if any
194
336
        if self.update_hook is not None:
195
337
            self.update_hook()
196
338
    
 
339
    def update_timer(self):
 
340
        "called by gobject"
 
341
        self.update()
 
342
        return True             # Keep calling this
 
343
    
197
344
    def delete(self):
 
345
        if self._update_timer_callback_tag is not None:
 
346
            gobject.source_remove(self._update_timer_callback_tag)
 
347
            self._update_timer_callback_tag = None
198
348
        if self.delete_hook is not None:
199
349
            self.delete_hook(self)
200
350
    
201
 
    def render(self, (maxcol,), focus=False):
 
351
    def render(self, maxcolrow, focus=False):
202
352
        """Render differently if we have focus.
203
353
        This overrides the method from urwid.FlowWidget"""
204
 
        return self.current_widget(focus).render((maxcol,),
 
354
        return self.current_widget(focus).render(maxcolrow,
205
355
                                                 focus=focus)
206
356
    
207
 
    def keypress(self, (maxcol,), key):
 
357
    def keypress(self, maxcolrow, key):
208
358
        """Handle keys.
209
359
        This overrides the method from urwid.FlowWidget"""
210
 
        if key == u"e" or key == u"+":
211
 
            self.proxy.Enable()
212
 
        elif key == u"d" or key == u"-":
213
 
            self.proxy.Disable()
214
 
        elif key == u"r" or key == u"_" or key == u"ctrl k":
 
360
        if key == u"+":
 
361
            self.proxy.Enable(dbus_interface = client_interface)
 
362
        elif key == u"-":
 
363
            self.proxy.Disable(dbus_interface = client_interface)
 
364
        elif key == u"a":
 
365
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
 
366
                               dbus_interface = client_interface)
 
367
        elif key == u"d":
 
368
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
 
369
                                  dbus_interface = client_interface)
 
370
        elif key == u"R" or key == u"_" or key == u"ctrl k":
215
371
            self.server_proxy_object.RemoveClient(self.proxy
216
372
                                                  .object_path)
217
373
        elif key == u"s":
218
 
            self.proxy.StartChecker()
 
374
            self.proxy.StartChecker(dbus_interface = client_interface)
219
375
        elif key == u"S":
220
 
            self.proxy.StopChecker()
 
376
            self.proxy.StopChecker(dbus_interface = client_interface)
221
377
        elif key == u"C":
222
 
            self.proxy.CheckedOK()
 
378
            self.proxy.CheckedOK(dbus_interface = client_interface)
223
379
        # xxx
224
380
#         elif key == u"p" or key == "=":
225
381
#             self.proxy.pause()
247
403
    "down" key presses, thus not allowing any containing widgets to
248
404
    use them as an excuse to shift focus away from this widget.
249
405
    """
250
 
    def keypress(self, (maxcol, maxrow), key):
251
 
        ret = super(ConstrainedListBox, self).keypress((maxcol, maxrow), key)
 
406
    def keypress(self, maxcolrow, key):
 
407
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
252
408
        if ret in (u"up", u"down"):
253
409
            return
254
410
        return ret
371
527
        Call this when the widget layout needs to change"""
372
528
        self.uilist = []
373
529
        #self.uilist.append(urwid.ListBox(self.clients))
374
 
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
 
530
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
 
531
                                                          clients),
375
532
                                       #header=urwid.Divider(),
376
533
                                       header=None,
377
 
                                       footer=urwid.Divider(div_char=self.divider)))
 
534
                                       footer=
 
535
                                       urwid.Divider(div_char=
 
536
                                                     self.divider)))
378
537
        if self.log_visible:
379
538
            self.uilist.append(self.logbox)
380
539
            pass
398
557
        """Toggle visibility of the log buffer."""
399
558
        self.log_visible = not self.log_visible
400
559
        self.rebuild()
401
 
        self.log_message(u"Log visibility changed to: "
402
 
                         + unicode(self.log_visible))
 
560
        #self.log_message(u"Log visibility changed to: "
 
561
        #                 + unicode(self.log_visible))
403
562
    
404
563
    def change_log_display(self):
405
564
        """Change type of log display.
410
569
            self.log_wrap = u"clip"
411
570
        for textwidget in self.log:
412
571
            textwidget.set_wrap_mode(self.log_wrap)
413
 
        self.log_message(u"Wrap mode: " + self.log_wrap)
 
572
        #self.log_message(u"Wrap mode: " + self.log_wrap)
414
573
    
415
574
    def find_and_remove_client(self, path, name):
416
575
        """Find an client from its object path and remove it.
424
583
            return
425
584
        self.remove_client(client, path)
426
585
    
427
 
    def add_new_client(self, path, properties):
 
586
    def add_new_client(self, path):
428
587
        client_proxy_object = self.bus.get_object(self.busname, path)
429
588
        self.add_client(MandosClientWidget(server_proxy_object
430
589
                                           =self.mandos_serv,
431
590
                                           proxy_object
432
591
                                           =client_proxy_object,
433
 
                                           properties=properties,
434
592
                                           update_hook
435
593
                                           =self.refresh,
436
594
                                           delete_hook
437
 
                                           =self.remove_client),
 
595
                                           =self.remove_client,
 
596
                                           logger
 
597
                                           =self.log_message),
438
598
                        path=path)
439
599
    
440
600
    def add_client(self, client, path=None):
442
602
        if path is None:
443
603
            path = client.proxy.object_path
444
604
        self.clients_dict[path] = client
445
 
        self.clients.sort(None, lambda c: c.properties[u"name"])
 
605
        self.clients.sort(None, lambda c: c.properties[u"Name"])
446
606
        self.refresh()
447
607
    
448
608
    def remove_client(self, client, path=None):
523
683
                self.log_message_raw((u"bold",
524
684
                                      u"  "
525
685
                                      .join((u"Clients:",
526
 
                                             u"e: Enable",
527
 
                                             u"d: Disable",
528
 
                                             u"r: Remove",
 
686
                                             u"+: Enable",
 
687
                                             u"-: Disable",
 
688
                                             u"R: Remove",
529
689
                                             u"s: Start new checker",
530
690
                                             u"S: Stop checker",
531
 
                                             u"C: Checker OK"))))
 
691
                                             u"C: Checker OK",
 
692
                                             u"a: Approve",
 
693
                                             u"d: Deny"))))
532
694
                self.refresh()
533
695
            elif key == u"tab":
534
696
                if self.topwidget.get_focus() is self.logbox:
562
724
ui = UserInterface()
563
725
try:
564
726
    ui.run()
565
 
except:
 
727
except KeyboardInterrupt:
 
728
    ui.screen.stop()
 
729
except Exception, e:
 
730
    ui.log_message(unicode(e))
566
731
    ui.screen.stop()
567
732
    raise