/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: 2009-12-25 23:13:47 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091225231347-gg9u9ru0wj0f24hh
More consistent terminology: Clients are no longer "invalid" - they
are "disabled".  All code and documentation changed to reflect this.

D=Bus API change: The "properties" argument was removed from the
"ClientAdded" signal on interface "se.bsnet.fukt.Mandos".  All code in
both "mandos" and "mandos-monitor" changed to reflect this.

* mandos: Replaced "with closing(F)" with simply "with F" in all
          places where F is a file object.
  (Client.still_valid): Removed.  All callers changed to look at
                        "Client.enabled" instead.
  (dbus_service_property): Check for unsupported signatures with the
                           "byte_arrays" option.
  (DBusObjectWithProperties.Set): - '' -
  (ClientHandler.handle): Use the reverse pipe to receive the
                          "Client.enabled" attribute instead of the
                          now-removed "Client.still_valid()" method.
  (ForkingMixInWithPipe): Renamed to "ForkingMixInWithPipes" (all
                          users changed).  Now also create a reverse
                          pipe for sending data to the child process.
  (ForkingMixInWithPipes.add_pipe): Now takes two pipe fd's as
                                    arguments.  All callers changed.
  (IPv6_TCPServer.handle_ipc): Take an additional "reply_fd" argument
                               (all callers changed).  Close the reply
                               pipe when the child data pipe is
                               closed.  New "GETATTR" IPC method; will
                               pickle client attribute and send it
                               over the reply pipe FD.
  (MandosDBusService.ClientAdded): Removed "properties" argument.  All
                                   emitters changed.
* mandos-clients.conf.xml (DESCRIPTION, OPTIONS): Use
                                                  "enabled/disabled"
                                                  terminology.
* mandos-ctl: Option "--is-valid" renamed to "--is-enabled".
* mandos-monitor: Enable user locale.  Try to log exceptions.
  (MandosClientPropertyCache.__init__): Removed "properties" argument.
                                        All callers changed.
  (UserInterface.add_new_client): Remove "properties" argument.  All
                                  callers changed.  Supply "logger"
                                  argument to MandosClientWidget().
  (UserInterface.add_client): New "logger" argument.  All callers
                              changed.
* mandos.xml (BUGS, SECURITY/CLIENTS): Use "enabled/disabled"
                                       terminology.

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
 
# 
24
3
 
25
4
from __future__ import division, absolute_import, with_statement
26
5
 
44
23
 
45
24
locale.setlocale(locale.LC_ALL, u'')
46
25
 
47
 
import logging
48
 
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
49
 
 
50
26
# Some useful constants
51
27
domain = 'se.bsnet.fukt'
52
28
server_interface = domain + '.Mandos'
53
29
client_interface = domain + '.Mandos.Client'
54
 
version = "1.2"
 
30
version = "1.0.14"
55
31
 
56
32
# Always run in monochrome mode
57
33
urwid.curses_display.curses.has_colors = lambda : False
61
37
urwid.curses_display.curses.A_UNDERLINE |= (
62
38
    urwid.curses_display.curses.A_BLINK)
63
39
 
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
 
 
80
40
class MandosClientPropertyCache(object):
81
41
    """This wraps a Mandos Client D-Bus proxy object, caches the
82
42
    properties and calls a hook function when any of them are
90
50
                                     self.property_changed,
91
51
                                     client_interface,
92
52
                                     byte_arrays=True)
93
 
        
 
53
 
94
54
        self.properties.update(
95
55
            self.proxy.GetAll(client_interface,
96
56
                              dbus_interface = dbus.PROPERTIES_IFACE))
97
 
 
98
 
        #XXX This break good super behaviour!
99
 
#        super(MandosClientPropertyCache, self).__init__(
100
 
#            *args, **kwargs)
 
57
        super(MandosClientPropertyCache, self).__init__(
 
58
            proxy_object=proxy_object, *args, **kwargs)
101
59
    
102
60
    def property_changed(self, property=None, value=None):
103
61
        """This is called whenever we get a PropertyChanged signal
122
80
        # Logger
123
81
        self.logger = logger
124
82
        
125
 
        self._update_timer_callback_tag = None
126
 
        self._update_timer_callback_lock = 0
127
 
        self.last_checker_failed = False
128
 
        
129
83
        # The widget shown normally
130
84
        self._text_widget = urwid.Text(u"")
131
85
        # The widget shown when we have focus
135
89
            *args, **kwargs)
136
90
        self.update()
137
91
        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
 
        
157
92
        self.proxy.connect_to_signal(u"CheckerCompleted",
158
93
                                     self.checker_completed,
159
94
                                     client_interface,
166
101
                                     self.got_secret,
167
102
                                     client_interface,
168
103
                                     byte_arrays=True)
169
 
        self.proxy.connect_to_signal(u"NeedApproval",
170
 
                                     self.need_approval,
171
 
                                     client_interface,
172
 
                                     byte_arrays=True)
173
104
        self.proxy.connect_to_signal(u"Rejected",
174
105
                                     self.rejected,
175
106
                                     client_interface,
176
107
                                     byte_arrays=True)
177
108
    
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
 
    
201
109
    def checker_completed(self, exitstatus, condition, command):
202
110
        if exitstatus == 0:
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()
 
111
            self.logger(u'Checker for client %s (command "%s")'
 
112
                        u' was successful'
 
113
                        % (self.properties[u"name"], command))
210
114
            return
211
 
        # Checker failed
212
 
        if not self.last_checker_failed:
213
 
            self.last_checker_failed = True
214
 
            self.using_timer(True)
215
115
        if os.WIFEXITED(condition):
216
116
            self.logger(u'Checker for client %s (command "%s")'
217
117
                        u' failed with exit code %s'
218
 
                        % (self.properties[u"Name"], command,
 
118
                        % (self.properties[u"name"], command,
219
119
                           os.WEXITSTATUS(condition)))
220
 
        elif os.WIFSIGNALED(condition):
 
120
            return
 
121
        if os.WIFSIGNALED(condition):
221
122
            self.logger(u'Checker for client %s (command "%s")'
222
123
                        u' was killed by signal %s'
223
 
                        % (self.properties[u"Name"], command,
 
124
                        % (self.properties[u"name"], command,
224
125
                           os.WTERMSIG(condition)))
225
 
        elif os.WCOREDUMP(condition):
 
126
            return
 
127
        if os.WCOREDUMP(condition):
226
128
            self.logger(u'Checker for client %s (command "%s")'
227
129
                        u' dumped core'
228
 
                        % (self.properties[u"Name"], command))
229
 
        else:
230
 
            self.logger(u'Checker for client %s completed'
231
 
                        u' mysteriously')
232
 
        self.update()
 
130
                        % (self.properties[u"name"], command))
 
131
        self.logger(u'Checker for client %s completed mysteriously')
233
132
    
234
133
    def checker_started(self, command):
235
 
        #self.logger(u'Client %s started checker "%s"'
236
 
        #            % (self.properties[u"Name"], unicode(command)))
237
 
        pass
 
134
        self.logger(u'Client %s started checker "%s"'
 
135
                    % (self.properties[u"name"], unicode(command)))
238
136
    
239
137
    def got_secret(self):
240
 
        self.last_checker_failed = False
241
138
        self.logger(u'Client %s received its secret'
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))
 
139
                    % self.properties[u"name"])
 
140
    
 
141
    def rejected(self):
 
142
        self.logger(u'Client %s was rejected'
 
143
                    % self.properties[u"name"])
256
144
    
257
145
    def selectable(self):
258
146
        """Make this a "selectable" widget.
280
168
                          u"bold-underline-blink":
281
169
                              u"bold-underline-blink-standout",
282
170
                          }
283
 
 
 
171
        
284
172
        # Rebuild focus and non-focus widgets using current properties
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 = "%s%s" % (base, message)
322
 
            
 
173
        self._text = (u'%(name)s: %(enabled)s'
 
174
                      % { u"name": self.properties[u"name"],
 
175
                          u"enabled":
 
176
                              (u"enabled"
 
177
                               if self.properties[u"enabled"]
 
178
                               else u"DISABLED")})
323
179
        if not urwid.supports_unicode():
324
180
            self._text = self._text.encode("ascii", "replace")
325
181
        textlist = [(u"normal", self._text)]
336
192
        if self.update_hook is not None:
337
193
            self.update_hook()
338
194
    
339
 
    def update_timer(self):
340
 
        "called by gobject"
341
 
        self.update()
342
 
        return True             # Keep calling this
343
 
    
344
195
    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
348
196
        if self.delete_hook is not None:
349
197
            self.delete_hook(self)
350
198
    
357
205
    def keypress(self, (maxcol,), key):
358
206
        """Handle keys.
359
207
        This overrides the method from urwid.FlowWidget"""
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":
 
208
        if key == u"e" or key == u"+":
 
209
            self.proxy.Enable()
 
210
        elif key == u"d" or key == u"-":
 
211
            self.proxy.Disable()
 
212
        elif key == u"r" or key == u"_" or key == u"ctrl k":
371
213
            self.server_proxy_object.RemoveClient(self.proxy
372
214
                                                  .object_path)
373
215
        elif key == u"s":
374
 
            self.proxy.StartChecker(dbus_interface = client_interface)
 
216
            self.proxy.StartChecker()
375
217
        elif key == u"S":
376
 
            self.proxy.StopChecker(dbus_interface = client_interface)
 
218
            self.proxy.StopChecker()
377
219
        elif key == u"C":
378
 
            self.proxy.CheckedOK(dbus_interface = client_interface)
 
220
            self.proxy.CheckedOK()
379
221
        # xxx
380
222
#         elif key == u"p" or key == "=":
381
223
#             self.proxy.pause()
404
246
    use them as an excuse to shift focus away from this widget.
405
247
    """
406
248
    def keypress(self, (maxcol, maxrow), key):
407
 
        ret = super(ConstrainedListBox, self).keypress((maxcol,
408
 
                                                        maxrow), key)
 
249
        ret = super(ConstrainedListBox, self).keypress((maxcol, maxrow), key)
409
250
        if ret in (u"up", u"down"):
410
251
            return
411
252
        return ret
528
369
        Call this when the widget layout needs to change"""
529
370
        self.uilist = []
530
371
        #self.uilist.append(urwid.ListBox(self.clients))
531
 
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
532
 
                                                          clients),
 
372
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
533
373
                                       #header=urwid.Divider(),
534
374
                                       header=None,
535
 
                                       footer=
536
 
                                       urwid.Divider(div_char=
537
 
                                                     self.divider)))
 
375
                                       footer=urwid.Divider(div_char=self.divider)))
538
376
        if self.log_visible:
539
377
            self.uilist.append(self.logbox)
540
378
            pass
558
396
        """Toggle visibility of the log buffer."""
559
397
        self.log_visible = not self.log_visible
560
398
        self.rebuild()
561
 
        #self.log_message(u"Log visibility changed to: "
562
 
        #                 + unicode(self.log_visible))
 
399
        self.log_message(u"Log visibility changed to: "
 
400
                         + unicode(self.log_visible))
563
401
    
564
402
    def change_log_display(self):
565
403
        """Change type of log display.
570
408
            self.log_wrap = u"clip"
571
409
        for textwidget in self.log:
572
410
            textwidget.set_wrap_mode(self.log_wrap)
573
 
        #self.log_message(u"Wrap mode: " + self.log_wrap)
 
411
        self.log_message(u"Wrap mode: " + self.log_wrap)
574
412
    
575
413
    def find_and_remove_client(self, path, name):
576
414
        """Find an client from its object path and remove it.
603
441
        if path is None:
604
442
            path = client.proxy.object_path
605
443
        self.clients_dict[path] = client
606
 
        self.clients.sort(None, lambda c: c.properties[u"Name"])
 
444
        self.clients.sort(None, lambda c: c.properties[u"name"])
607
445
        self.refresh()
608
446
    
609
447
    def remove_client(self, client, path=None):
684
522
                self.log_message_raw((u"bold",
685
523
                                      u"  "
686
524
                                      .join((u"Clients:",
687
 
                                             u"+: Enable",
688
 
                                             u"-: Disable",
689
 
                                             u"R: Remove",
 
525
                                             u"e: Enable",
 
526
                                             u"d: Disable",
 
527
                                             u"r: Remove",
690
528
                                             u"s: Start new checker",
691
529
                                             u"S: Stop checker",
692
 
                                             u"C: Checker OK",
693
 
                                             u"a: Approve",
694
 
                                             u"d: Deny"))))
 
530
                                             u"C: Checker OK"))))
695
531
                self.refresh()
696
532
            elif key == u"tab":
697
533
                if self.topwidget.get_focus() is self.logbox:
725
561
ui = UserInterface()
726
562
try:
727
563
    ui.run()
728
 
except KeyboardInterrupt:
729
 
    ui.screen.stop()
730
564
except Exception, e:
731
565
    ui.log_message(unicode(e))
732
566
    ui.screen.stop()