/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 Hogeborn
  • Date: 2014-06-22 02:19:30 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 317.
  • Revision ID: teddy@recompile.se-20140622021930-icl7h4cm97blhjml
mandos-keygen: Generate "checker" option to use SSH fingerprints.

To turn this off, use a new "--no-ssh" option to mandos-keygen.

* INSTALL (Mandos Server, Mandos Client): Document new suggested
                                          installation of SSH.
* Makefile (confdir/clients.conf): Use new "--no-ssh" option to
                                   "mandos-keygen".
* debian/control (mandos/Depends): Changed to "fping | ssh-client".
  (mandos-client/Recommends): New; set to "ssh".
* intro.xml (FREQUENTLY ASKED QUESTIONS): Rename and rewrite section
                                          called "Faking ping
                                          replies?" to address new
                                          default behavior.
* mandos-clients.conf.xml (OPTIONS/checker): Briefly discuss new
                                             behavior of
                                             mandos-keygen.
* mandos-keygen: Bug fix: Suppress failure output of "shred" to remove
                 "sec*", since no such files may exist.
 (password mode): Scan for SSH key fingerprints and output as new
                  "checker" and "ssh_fingerprint" options, unless new
                  "--no-ssh" option is given.
* mandos-keygen.xml (SYNOPSIS/--force): Bug fix: Document short form.
  (OPTIONS/--no-ssh): New.
  (SEE ALSO): Add reference "ssh-keyscan(1)".
* plugins.d/mandos-client.xml (SECURITY): Briefly mention the
                                          possibility of using SSH key
                                          fingerprints for checking.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-monitor
1
 
#!/usr/bin/python3 -bbI
 
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
 
#
 
3
# 
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
 
#
6
 
# Copyright © 2009-2019 Teddy Hogeborn
7
 
# Copyright © 2009-2019 Björn Påhlsson
8
 
#
9
 
# This file is part of Mandos.
10
 
#
11
 
# Mandos is free software: you can redistribute it and/or modify it
12
 
# under the terms of the GNU General Public License as published by
 
5
# 
 
6
# Copyright © 2009-2014 Teddy Hogeborn
 
7
# Copyright © 2009-2014 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
13
11
# the Free Software Foundation, either version 3 of the License, or
14
12
# (at your option) any later version.
15
13
#
16
 
#     Mandos is distributed in the hope that it will be useful, but
17
 
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
14
#     This program is distributed in the hope that it will be useful,
 
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
18
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19
17
#     GNU General Public License for more details.
20
 
#
 
18
# 
21
19
# You should have received a copy of the GNU General Public License
22
 
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
23
 
#
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
 
22
# 
24
23
# Contact the authors at <mandos@recompile.se>.
25
 
#
 
24
# 
26
25
 
27
26
from __future__ import (division, absolute_import, print_function,
28
27
                        unicode_literals)
33
32
 
34
33
import sys
35
34
import os
36
 
import warnings
 
35
 
37
36
import datetime
38
 
import locale
39
 
import logging
40
37
 
41
38
import urwid.curses_display
42
39
import urwid
43
40
 
44
41
from dbus.mainloop.glib import DBusGMainLoop
45
 
from gi.repository import GLib
 
42
try:
 
43
    import gobject
 
44
except ImportError:
 
45
    from gi.repository import GObject as gobject
46
46
 
47
47
import dbus
48
48
 
49
 
if sys.version_info.major == 2:
50
 
    __metaclass__ = type
 
49
import locale
 
50
 
 
51
if sys.version_info[0] == 2:
51
52
    str = unicode
52
53
 
53
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
54
 
logging.basicConfig(level="NOTSET", # Show all messages
55
 
                    format="%(message)s") # Show basic log messages
56
 
 
57
 
logging.captureWarnings(True)   # Show warnings via the logging system
58
 
 
59
 
locale.setlocale(locale.LC_ALL, "")
60
 
 
61
 
logging.getLogger("dbus.proxies").setLevel(logging.CRITICAL)
 
54
locale.setlocale(locale.LC_ALL, '')
 
55
 
 
56
import logging
 
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
62
58
 
63
59
# Some useful constants
64
 
domain = "se.recompile"
65
 
server_interface = domain + ".Mandos"
66
 
client_interface = domain + ".Mandos.Client"
67
 
version = "1.8.12"
68
 
 
69
 
try:
70
 
    dbus.OBJECT_MANAGER_IFACE
71
 
except AttributeError:
72
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
73
 
 
 
60
domain = 'se.recompile'
 
61
server_interface = domain + '.Mandos'
 
62
client_interface = domain + '.Mandos.Client'
 
63
version = "1.6.5"
74
64
 
75
65
def isoformat_to_datetime(iso):
76
66
    "Parse an ISO 8601 date string to a datetime.datetime()"
85
75
                             int(day),
86
76
                             int(hour),
87
77
                             int(minute),
88
 
                             int(second),            # Whole seconds
89
 
                             int(fraction*1000000))  # Microseconds
90
 
 
91
 
 
92
 
class MandosClientPropertyCache:
 
78
                             int(second),           # Whole seconds
 
79
                             int(fraction*1000000)) # Microseconds
 
80
 
 
81
class MandosClientPropertyCache(object):
93
82
    """This wraps a Mandos Client D-Bus proxy object, caches the
94
83
    properties and calls a hook function when any of them are
95
84
    changed.
96
85
    """
97
86
    def __init__(self, proxy_object=None, properties=None, **kwargs):
98
 
        self.proxy = proxy_object  # Mandos Client proxy object
 
87
        self.proxy = proxy_object # Mandos Client proxy object
99
88
        self.properties = dict() if properties is None else properties
100
89
        self.property_changed_match = (
101
 
            self.proxy.connect_to_signal("PropertiesChanged",
102
 
                                         self.properties_changed,
103
 
                                         dbus.PROPERTIES_IFACE,
 
90
            self.proxy.connect_to_signal("PropertyChanged",
 
91
                                         self._property_changed,
 
92
                                         client_interface,
104
93
                                         byte_arrays=True))
105
 
 
 
94
        
106
95
        if properties is None:
107
 
            self.properties.update(self.proxy.GetAll(
108
 
                client_interface,
109
 
                dbus_interface=dbus.PROPERTIES_IFACE))
110
 
 
 
96
            self.properties.update(
 
97
                self.proxy.GetAll(client_interface,
 
98
                                  dbus_interface
 
99
                                  = dbus.PROPERTIES_IFACE))
 
100
        
111
101
        super(MandosClientPropertyCache, self).__init__(**kwargs)
112
 
 
113
 
    def properties_changed(self, interface, properties, invalidated):
114
 
        """This is called whenever we get a PropertiesChanged signal
115
 
        It updates the changed properties in the "properties" dict.
 
102
    
 
103
    def _property_changed(self, property, value):
 
104
        """Helper which takes positional arguments"""
 
105
        return self.property_changed(property=property, value=value)
 
106
    
 
107
    def property_changed(self, property=None, value=None):
 
108
        """This is called whenever we get a PropertyChanged signal
 
109
        It updates the changed property in the "properties" dict.
116
110
        """
117
111
        # Update properties dict with new value
118
 
        if interface == client_interface:
119
 
            self.properties.update(properties)
120
 
 
 
112
        self.properties[property] = value
 
113
    
121
114
    def delete(self):
122
115
        self.property_changed_match.remove()
123
116
 
125
118
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
126
119
    """A Mandos Client which is visible on the screen.
127
120
    """
128
 
 
 
121
    
129
122
    def __init__(self, server_proxy_object=None, update_hook=None,
130
 
                 delete_hook=None, **kwargs):
 
123
                 delete_hook=None, logger=None, **kwargs):
131
124
        # Called on update
132
125
        self.update_hook = update_hook
133
126
        # Called on delete
134
127
        self.delete_hook = delete_hook
135
128
        # Mandos Server proxy object
136
129
        self.server_proxy_object = server_proxy_object
137
 
 
 
130
        # Logger
 
131
        self.logger = logger
 
132
        
138
133
        self._update_timer_callback_tag = None
139
 
 
 
134
        
140
135
        # The widget shown normally
141
136
        self._text_widget = urwid.Text("")
142
137
        # The widget shown when we have focus
144
139
        super(MandosClientWidget, self).__init__(**kwargs)
145
140
        self.update()
146
141
        self.opened = False
147
 
 
 
142
        
148
143
        self.match_objects = (
149
144
            self.proxy.connect_to_signal("CheckerCompleted",
150
145
                                         self.checker_completed,
166
161
                                         self.rejected,
167
162
                                         client_interface,
168
163
                                         byte_arrays=True))
169
 
        log.debug("Created client %s", self.properties["Name"])
170
 
 
 
164
        #self.logger('Created client {0}'
 
165
        #            .format(self.properties["Name"]))
 
166
    
171
167
    def using_timer(self, flag):
172
168
        """Call this method with True or False when timer should be
173
169
        activated or deactivated.
174
170
        """
175
171
        if flag and self._update_timer_callback_tag is None:
176
172
            # Will update the shown timer value every second
177
 
            self._update_timer_callback_tag = (
178
 
                GLib.timeout_add(1000,
179
 
                                 glib_safely(self.update_timer)))
 
173
            self._update_timer_callback_tag = (gobject.timeout_add
 
174
                                               (1000,
 
175
                                                self.update_timer))
180
176
        elif not (flag or self._update_timer_callback_tag is None):
181
 
            GLib.source_remove(self._update_timer_callback_tag)
 
177
            gobject.source_remove(self._update_timer_callback_tag)
182
178
            self._update_timer_callback_tag = None
183
 
 
 
179
    
184
180
    def checker_completed(self, exitstatus, condition, command):
185
181
        if exitstatus == 0:
186
 
            log.debug('Checker for client %s (command "%s")'
187
 
                      " succeeded", self.properties["Name"], command)
188
182
            self.update()
189
183
            return
190
184
        # Checker failed
191
185
        if os.WIFEXITED(condition):
192
 
            log.info('Checker for client %s (command "%s") failed'
193
 
                     " with exit code %d", self.properties["Name"],
194
 
                     command, os.WEXITSTATUS(condition))
 
186
            self.logger('Checker for client {0} (command "{1}")'
 
187
                        ' failed with exit code {2}'
 
188
                        .format(self.properties["Name"], command,
 
189
                                os.WEXITSTATUS(condition)))
195
190
        elif os.WIFSIGNALED(condition):
196
 
            log.info('Checker for client %s (command "%s") was'
197
 
                     " killed by signal %d", self.properties["Name"],
198
 
                     command, os.WTERMSIG(condition))
 
191
            self.logger('Checker for client {0} (command "{1}") was'
 
192
                        ' killed by signal {2}'
 
193
                        .format(self.properties["Name"], command,
 
194
                                os.WTERMSIG(condition)))
 
195
        elif os.WCOREDUMP(condition):
 
196
            self.logger('Checker for client {0} (command "{1}")'
 
197
                        ' dumped core'
 
198
                        .format(self.properties["Name"], command))
 
199
        else:
 
200
            self.logger('Checker for client {0} completed'
 
201
                        ' mysteriously'
 
202
                        .format(self.properties["Name"]))
199
203
        self.update()
200
 
 
 
204
    
201
205
    def checker_started(self, command):
202
 
        """Server signals that a checker started."""
203
 
        log.debug('Client %s started checker "%s"',
204
 
                  self.properties["Name"], command)
205
 
 
 
206
        """Server signals that a checker started. This could be useful
 
207
           to log in the future. """
 
208
        #self.logger('Client {0} started checker "{1}"'
 
209
        #            .format(self.properties["Name"],
 
210
        #                    str(command)))
 
211
        pass
 
212
    
206
213
    def got_secret(self):
207
 
        log.info("Client %s received its secret",
208
 
                 self.properties["Name"])
209
 
 
 
214
        self.logger('Client {0} received its secret'
 
215
                    .format(self.properties["Name"]))
 
216
    
210
217
    def need_approval(self, timeout, default):
211
218
        if not default:
212
 
            message = "Client %s needs approval within %f seconds"
 
219
            message = 'Client {0} needs approval within {1} seconds'
213
220
        else:
214
 
            message = "Client %s will get its secret in %f seconds"
215
 
        log.info(message, self.properties["Name"], timeout/1000)
216
 
 
 
221
            message = 'Client {0} will get its secret in {1} seconds'
 
222
        self.logger(message.format(self.properties["Name"],
 
223
                                   timeout/1000))
 
224
    
217
225
    def rejected(self, reason):
218
 
        log.info("Client %s was rejected; reason: %s",
219
 
                 self.properties["Name"], reason)
220
 
 
 
226
        self.logger('Client {0} was rejected; reason: {1}'
 
227
                    .format(self.properties["Name"], reason))
 
228
    
221
229
    def selectable(self):
222
230
        """Make this a "selectable" widget.
223
231
        This overrides the method from urwid.FlowWidget."""
224
232
        return True
225
 
 
 
233
    
226
234
    def rows(self, maxcolrow, focus=False):
227
235
        """How many rows this widget will occupy might depend on
228
236
        whether we have focus or not.
229
237
        This overrides the method from urwid.FlowWidget"""
230
238
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
231
 
 
 
239
    
232
240
    def current_widget(self, focus=False):
233
241
        if focus or self.opened:
234
242
            return self._focus_widget
235
243
        return self._widget
236
 
 
 
244
    
237
245
    def update(self):
238
246
        "Called when what is visible on the screen should be updated."
239
247
        # How to add standout mode to a style
240
 
        with_standout = {"normal": "standout",
241
 
                         "bold": "bold-standout",
242
 
                         "underline-blink":
243
 
                         "underline-blink-standout",
244
 
                         "bold-underline-blink":
245
 
                         "bold-underline-blink-standout",
246
 
                         }
247
 
 
 
248
        with_standout = { "normal": "standout",
 
249
                          "bold": "bold-standout",
 
250
                          "underline-blink":
 
251
                              "underline-blink-standout",
 
252
                          "bold-underline-blink":
 
253
                              "bold-underline-blink-standout",
 
254
                          }
 
255
        
248
256
        # Rebuild focus and non-focus widgets using current properties
249
 
 
 
257
        
250
258
        # Base part of a client. Name!
251
 
        base = "{name}: ".format(name=self.properties["Name"])
 
259
        base = '{name}: '.format(name=self.properties["Name"])
252
260
        if not self.properties["Enabled"]:
253
261
            message = "DISABLED"
254
262
            self.using_timer(False)
255
263
        elif self.properties["ApprovalPending"]:
256
 
            timeout = datetime.timedelta(
257
 
                milliseconds=self.properties["ApprovalDelay"])
 
264
            timeout = datetime.timedelta(milliseconds
 
265
                                         = self.properties
 
266
                                         ["ApprovalDelay"])
258
267
            last_approval_request = isoformat_to_datetime(
259
268
                self.properties["LastApprovalRequest"])
260
269
            if last_approval_request is not None:
264
273
            else:
265
274
                timer = datetime.timedelta()
266
275
            if self.properties["ApprovedByDefault"]:
267
 
                message = "Approval in {}. (d)eny?"
 
276
                message = "Approval in {0}. (d)eny?"
268
277
            else:
269
 
                message = "Denial in {}. (a)pprove?"
 
278
                message = "Denial in {0}. (a)pprove?"
270
279
            message = message.format(str(timer).rsplit(".", 1)[0])
271
280
            self.using_timer(True)
272
281
        elif self.properties["LastCheckerStatus"] != 0:
276
285
                timer = datetime.timedelta(0)
277
286
            else:
278
287
                expires = (datetime.datetime.strptime
279
 
                           (expires, "%Y-%m-%dT%H:%M:%S.%f"))
 
288
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
280
289
                timer = max(expires - datetime.datetime.utcnow(),
281
290
                            datetime.timedelta())
282
 
            message = ("A checker has failed! Time until client"
283
 
                       " gets disabled: {}"
 
291
            message = ('A checker has failed! Time until client'
 
292
                       ' gets disabled: {0}'
284
293
                       .format(str(timer).rsplit(".", 1)[0]))
285
294
            self.using_timer(True)
286
295
        else:
287
296
            message = "enabled"
288
297
            self.using_timer(False)
289
 
        self._text = "{}{}".format(base, message)
290
 
 
 
298
        self._text = "{0}{1}".format(base, message)
 
299
        
291
300
        if not urwid.supports_unicode():
292
301
            self._text = self._text.encode("ascii", "replace")
293
302
        textlist = [("normal", self._text)]
303
312
        # Run update hook, if any
304
313
        if self.update_hook is not None:
305
314
            self.update_hook()
306
 
 
 
315
    
307
316
    def update_timer(self):
308
 
        """called by GLib. Will indefinitely loop until
309
 
        GLib.source_remove() on tag is called
310
 
        """
 
317
        """called by gobject. Will indefinitely loop until
 
318
        gobject.source_remove() on tag is called"""
311
319
        self.update()
312
320
        return True             # Keep calling this
313
 
 
 
321
    
314
322
    def delete(self, **kwargs):
315
323
        if self._update_timer_callback_tag is not None:
316
 
            GLib.source_remove(self._update_timer_callback_tag)
 
324
            gobject.source_remove(self._update_timer_callback_tag)
317
325
            self._update_timer_callback_tag = None
318
326
        for match in self.match_objects:
319
327
            match.remove()
321
329
        if self.delete_hook is not None:
322
330
            self.delete_hook(self)
323
331
        return super(MandosClientWidget, self).delete(**kwargs)
324
 
 
 
332
    
325
333
    def render(self, maxcolrow, focus=False):
326
334
        """Render differently if we have focus.
327
335
        This overrides the method from urwid.FlowWidget"""
328
336
        return self.current_widget(focus).render(maxcolrow,
329
337
                                                 focus=focus)
330
 
 
 
338
    
331
339
    def keypress(self, maxcolrow, key):
332
340
        """Handle keys.
333
341
        This overrides the method from urwid.FlowWidget"""
334
342
        if key == "+":
335
 
            self.proxy.Set(client_interface, "Enabled",
336
 
                           dbus.Boolean(True), ignore_reply=True,
337
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
343
            self.proxy.Enable(dbus_interface = client_interface,
 
344
                              ignore_reply=True)
338
345
        elif key == "-":
339
 
            self.proxy.Set(client_interface, "Enabled", False,
340
 
                           ignore_reply=True,
341
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
346
            self.proxy.Disable(dbus_interface = client_interface,
 
347
                               ignore_reply=True)
342
348
        elif key == "a":
343
349
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
344
 
                               dbus_interface=client_interface,
 
350
                               dbus_interface = client_interface,
345
351
                               ignore_reply=True)
346
352
        elif key == "d":
347
353
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
348
 
                               dbus_interface=client_interface,
 
354
                                  dbus_interface = client_interface,
349
355
                               ignore_reply=True)
350
356
        elif key == "R" or key == "_" or key == "ctrl k":
351
357
            self.server_proxy_object.RemoveClient(self.proxy
352
358
                                                  .object_path,
353
359
                                                  ignore_reply=True)
354
360
        elif key == "s":
355
 
            self.proxy.Set(client_interface, "CheckerRunning",
356
 
                           dbus.Boolean(True), ignore_reply=True,
357
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
361
            self.proxy.StartChecker(dbus_interface = client_interface,
 
362
                                    ignore_reply=True)
358
363
        elif key == "S":
359
 
            self.proxy.Set(client_interface, "CheckerRunning",
360
 
                           dbus.Boolean(False), ignore_reply=True,
361
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
364
            self.proxy.StopChecker(dbus_interface = client_interface,
 
365
                                   ignore_reply=True)
362
366
        elif key == "C":
363
 
            self.proxy.CheckedOK(dbus_interface=client_interface,
 
367
            self.proxy.CheckedOK(dbus_interface = client_interface,
364
368
                                 ignore_reply=True)
365
369
        # xxx
366
370
#         elif key == "p" or key == "=":
371
375
#             self.open()
372
376
        else:
373
377
            return key
374
 
 
375
 
    def properties_changed(self, interface, properties, invalidated):
376
 
        """Call self.update() if any properties changed.
 
378
    
 
379
    def property_changed(self, property=None, **kwargs):
 
380
        """Call self.update() if old value is not new value.
377
381
        This overrides the method from MandosClientPropertyCache"""
378
 
        old_values = {key: self.properties.get(key)
379
 
                      for key in properties.keys()}
380
 
        super(MandosClientWidget, self).properties_changed(
381
 
            interface, properties, invalidated)
382
 
        if any(old_values[key] != self.properties.get(key)
383
 
               for key in old_values):
 
382
        property_name = str(property)
 
383
        old_value = self.properties.get(property_name)
 
384
        super(MandosClientWidget, self).property_changed(
 
385
            property=property, **kwargs)
 
386
        if self.properties.get(property_name) != old_value:
384
387
            self.update()
385
388
 
386
389
 
387
 
def glib_safely(func, retval=True):
388
 
    def safe_func(*args, **kwargs):
389
 
        try:
390
 
            return func(*args, **kwargs)
391
 
        except Exception:
392
 
            log.exception("")
393
 
            return retval
394
 
    return safe_func
395
 
 
396
 
 
397
390
class ConstrainedListBox(urwid.ListBox):
398
391
    """Like a normal urwid.ListBox, but will consume all "up" or
399
392
    "down" key presses, thus not allowing any containing widgets to
400
393
    use them as an excuse to shift focus away from this widget.
401
394
    """
402
395
    def keypress(self, *args, **kwargs):
403
 
        ret = (super(ConstrainedListBox, self)
404
 
               .keypress(*args, **kwargs))
 
396
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
405
397
        if ret in ("up", "down"):
406
398
            return
407
399
        return ret
408
400
 
409
401
 
410
 
class UserInterface:
 
402
class UserInterface(object):
411
403
    """This is the entire user interface - the whole screen
412
404
    with boxes, lists of client widgets, etc.
413
405
    """
414
406
    def __init__(self, max_log_length=1000):
415
407
        DBusGMainLoop(set_as_default=True)
416
 
 
 
408
        
417
409
        self.screen = urwid.curses_display.Screen()
418
 
 
 
410
        
419
411
        self.screen.register_palette((
420
412
                ("normal",
421
413
                 "default", "default", None),
426
418
                ("standout",
427
419
                 "standout", "default", "standout"),
428
420
                ("bold-underline-blink",
429
 
                 "bold,underline,blink", "default",
430
 
                 "bold,underline,blink"),
 
421
                 "bold,underline,blink", "default", "bold,underline,blink"),
431
422
                ("bold-standout",
432
423
                 "bold,standout", "default", "bold,standout"),
433
424
                ("underline-blink-standout",
437
428
                 "bold,underline,blink,standout", "default",
438
429
                 "bold,underline,blink,standout"),
439
430
                ))
440
 
 
 
431
        
441
432
        if urwid.supports_unicode():
442
 
            self.divider = "─"  # \u2500
 
433
            self.divider = "─" # \u2500
 
434
            #self.divider = "━" # \u2501
443
435
        else:
444
 
            self.divider = "_"  # \u005f
445
 
 
 
436
            #self.divider = "-" # \u002d
 
437
            self.divider = "_" # \u005f
 
438
        
446
439
        self.screen.start()
447
 
 
 
440
        
448
441
        self.size = self.screen.get_cols_rows()
449
 
 
 
442
        
450
443
        self.clients = urwid.SimpleListWalker([])
451
444
        self.clients_dict = {}
452
 
 
 
445
        
453
446
        # We will add Text widgets to this list
454
 
        self.log = urwid.SimpleListWalker([])
 
447
        self.log = []
455
448
        self.max_log_length = max_log_length
456
 
 
 
449
        
457
450
        # We keep a reference to the log widget so we can remove it
458
451
        # from the ListWalker without it getting destroyed
459
452
        self.logbox = ConstrainedListBox(self.log)
460
 
 
 
453
        
461
454
        # This keeps track of whether self.uilist currently has
462
455
        # self.logbox in it or not
463
456
        self.log_visible = True
464
457
        self.log_wrap = "any"
465
 
 
466
 
        self.loghandler = UILogHandler(self)
467
 
 
 
458
        
468
459
        self.rebuild()
469
 
        self.add_log_line(("bold",
470
 
                           "Mandos Monitor version " + version))
471
 
        self.add_log_line(("bold", "q: Quit  ?: Help"))
472
 
 
473
 
        self.busname = domain + ".Mandos"
474
 
        self.main_loop = GLib.MainLoop()
475
 
 
476
 
    def client_not_found(self, key_id, address):
477
 
        log.info("Client with address %s and key ID %s could"
478
 
                 " not be found", address, key_id)
479
 
 
 
460
        self.log_message_raw(("bold",
 
461
                              "Mandos Monitor version " + version))
 
462
        self.log_message_raw(("bold",
 
463
                              "q: Quit  ?: Help"))
 
464
        
 
465
        self.busname = domain + '.Mandos'
 
466
        self.main_loop = gobject.MainLoop()
 
467
    
 
468
    def client_not_found(self, fingerprint, address):
 
469
        self.log_message("Client with address {0} and fingerprint"
 
470
                         " {1} could not be found"
 
471
                         .format(address, fingerprint))
 
472
    
480
473
    def rebuild(self):
481
474
        """This rebuilds the User Interface.
482
475
        Call this when the widget layout needs to change"""
483
476
        self.uilist = []
484
 
        # self.uilist.append(urwid.ListBox(self.clients))
 
477
        #self.uilist.append(urwid.ListBox(self.clients))
485
478
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
486
479
                                                          clients),
487
 
                                       # header=urwid.Divider(),
 
480
                                       #header=urwid.Divider(),
488
481
                                       header=None,
489
 
                                       footer=urwid.Divider(
490
 
                                           div_char=self.divider)))
 
482
                                       footer=
 
483
                                       urwid.Divider(div_char=
 
484
                                                     self.divider)))
491
485
        if self.log_visible:
492
486
            self.uilist.append(self.logbox)
493
487
        self.topwidget = urwid.Pile(self.uilist)
494
 
 
495
 
    def add_log_line(self, markup):
 
488
    
 
489
    def log_message(self, message):
 
490
        """Log message formatted with timestamp"""
 
491
        timestamp = datetime.datetime.now().isoformat()
 
492
        self.log_message_raw(timestamp + ": " + message)
 
493
    
 
494
    def log_message_raw(self, markup):
 
495
        """Add a log message to the log buffer."""
496
496
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
497
 
        if self.max_log_length:
498
 
            if len(self.log) > self.max_log_length:
499
 
                del self.log[0:(len(self.log) - self.max_log_length)]
500
 
        self.logbox.set_focus(len(self.logbox.body.contents)-1,
 
497
        if (self.max_log_length
 
498
            and len(self.log) > self.max_log_length):
 
499
            del self.log[0:len(self.log)-self.max_log_length-1]
 
500
        self.logbox.set_focus(len(self.logbox.body.contents),
501
501
                              coming_from="above")
502
502
        self.refresh()
503
 
 
 
503
    
504
504
    def toggle_log_display(self):
505
505
        """Toggle visibility of the log buffer."""
506
506
        self.log_visible = not self.log_visible
507
507
        self.rebuild()
508
 
        log.debug("Log visibility changed to: %s", self.log_visible)
509
 
 
 
508
        #self.log_message("Log visibility changed to: "
 
509
        #                 + str(self.log_visible))
 
510
    
510
511
    def change_log_display(self):
511
512
        """Change type of log display.
512
513
        Currently, this toggles wrapping of text lines."""
516
517
            self.log_wrap = "clip"
517
518
        for textwidget in self.log:
518
519
            textwidget.set_wrap_mode(self.log_wrap)
519
 
        log.debug("Wrap mode: %s", self.log_wrap)
520
 
 
521
 
    def find_and_remove_client(self, path, interfaces):
 
520
        #self.log_message("Wrap mode: " + self.log_wrap)
 
521
    
 
522
    def find_and_remove_client(self, path, name):
522
523
        """Find a client by its object path and remove it.
523
 
 
524
 
        This is connected to the InterfacesRemoved signal from the
 
524
        
 
525
        This is connected to the ClientRemoved signal from the
525
526
        Mandos server object."""
526
 
        if client_interface not in interfaces:
527
 
            # Not a Mandos client object; ignore
528
 
            return
529
527
        try:
530
528
            client = self.clients_dict[path]
531
529
        except KeyError:
532
530
            # not found?
533
 
            log.warning("Unknown client %s removed", path)
 
531
            self.log_message("Unknown client {0!r} ({1!r}) removed"
 
532
                             .format(name, path))
534
533
            return
535
534
        client.delete()
536
 
 
537
 
    def add_new_client(self, path, ifs_and_props):
538
 
        """Find a client by its object path and remove it.
539
 
 
540
 
        This is connected to the InterfacesAdded signal from the
541
 
        Mandos server object.
542
 
        """
543
 
        if client_interface not in ifs_and_props:
544
 
            # Not a Mandos client object; ignore
545
 
            return
 
535
    
 
536
    def add_new_client(self, path):
546
537
        client_proxy_object = self.bus.get_object(self.busname, path)
547
 
        self.add_client(MandosClientWidget(
548
 
            server_proxy_object=self.mandos_serv,
549
 
            proxy_object=client_proxy_object,
550
 
            update_hook=self.refresh,
551
 
            delete_hook=self.remove_client,
552
 
            properties=dict(ifs_and_props[client_interface])),
 
538
        self.add_client(MandosClientWidget(server_proxy_object
 
539
                                           =self.mandos_serv,
 
540
                                           proxy_object
 
541
                                           =client_proxy_object,
 
542
                                           update_hook
 
543
                                           =self.refresh,
 
544
                                           delete_hook
 
545
                                           =self.remove_client,
 
546
                                           logger
 
547
                                           =self.log_message),
553
548
                        path=path)
554
 
 
 
549
    
555
550
    def add_client(self, client, path=None):
556
551
        self.clients.append(client)
557
552
        if path is None:
559
554
        self.clients_dict[path] = client
560
555
        self.clients.sort(key=lambda c: c.properties["Name"])
561
556
        self.refresh()
562
 
 
 
557
    
563
558
    def remove_client(self, client, path=None):
564
559
        self.clients.remove(client)
565
560
        if path is None:
566
561
            path = client.proxy.object_path
567
562
        del self.clients_dict[path]
568
563
        self.refresh()
569
 
 
 
564
    
570
565
    def refresh(self):
571
566
        """Redraw the screen"""
572
567
        canvas = self.topwidget.render(self.size, focus=True)
573
568
        self.screen.draw_screen(self.size, canvas)
574
 
 
 
569
    
575
570
    def run(self):
576
571
        """Start the main loop and exit when it's done."""
577
 
        log.addHandler(self.loghandler)
578
 
        self.orig_log_propagate = log.propagate
579
 
        log.propagate = False
580
 
        self.orig_log_level = log.level
581
 
        log.setLevel("INFO")
582
572
        self.bus = dbus.SystemBus()
583
573
        mandos_dbus_objc = self.bus.get_object(
584
574
            self.busname, "/", follow_name_owner_changes=True)
585
 
        self.mandos_serv = dbus.Interface(
586
 
            mandos_dbus_objc, dbus_interface=server_interface)
 
575
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
576
                                          dbus_interface
 
577
                                          = server_interface)
587
578
        try:
588
579
            mandos_clients = (self.mandos_serv
589
580
                              .GetAllClientsWithProperties())
590
581
            if not mandos_clients:
591
 
                log.warning("Note: Server has no clients.")
 
582
                self.log_message_raw(("bold", "Note: Server has no clients."))
592
583
        except dbus.exceptions.DBusException:
593
 
            log.warning("Note: No Mandos server running.")
 
584
            self.log_message_raw(("bold", "Note: No Mandos server running."))
594
585
            mandos_clients = dbus.Dictionary()
595
 
 
 
586
        
596
587
        (self.mandos_serv
597
 
         .connect_to_signal("InterfacesRemoved",
 
588
         .connect_to_signal("ClientRemoved",
598
589
                            self.find_and_remove_client,
599
 
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
 
590
                            dbus_interface=server_interface,
600
591
                            byte_arrays=True))
601
592
        (self.mandos_serv
602
 
         .connect_to_signal("InterfacesAdded",
 
593
         .connect_to_signal("ClientAdded",
603
594
                            self.add_new_client,
604
 
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
 
595
                            dbus_interface=server_interface,
605
596
                            byte_arrays=True))
606
597
        (self.mandos_serv
607
598
         .connect_to_signal("ClientNotFound",
611
602
        for path, client in mandos_clients.items():
612
603
            client_proxy_object = self.bus.get_object(self.busname,
613
604
                                                      path)
614
 
            self.add_client(MandosClientWidget(
615
 
                server_proxy_object=self.mandos_serv,
616
 
                proxy_object=client_proxy_object,
617
 
                properties=client,
618
 
                update_hook=self.refresh,
619
 
                delete_hook=self.remove_client),
 
605
            self.add_client(MandosClientWidget(server_proxy_object
 
606
                                               =self.mandos_serv,
 
607
                                               proxy_object
 
608
                                               =client_proxy_object,
 
609
                                               properties=client,
 
610
                                               update_hook
 
611
                                               =self.refresh,
 
612
                                               delete_hook
 
613
                                               =self.remove_client,
 
614
                                               logger
 
615
                                               =self.log_message),
620
616
                            path=path)
621
 
 
 
617
        
622
618
        self.refresh()
623
 
        self._input_callback_tag = (
624
 
            GLib.io_add_watch(
625
 
                GLib.IOChannel.unix_new(sys.stdin.fileno()),
626
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
627
 
                glib_safely(self.process_input)))
 
619
        self._input_callback_tag = (gobject.io_add_watch
 
620
                                    (sys.stdin.fileno(),
 
621
                                     gobject.IO_IN,
 
622
                                     self.process_input))
628
623
        self.main_loop.run()
629
624
        # Main loop has finished, we should close everything now
630
 
        GLib.source_remove(self._input_callback_tag)
631
 
        with warnings.catch_warnings():
632
 
            warnings.simplefilter("ignore", BytesWarning)
633
 
            self.screen.stop()
634
 
 
 
625
        gobject.source_remove(self._input_callback_tag)
 
626
        self.screen.stop()
 
627
    
635
628
    def stop(self):
636
629
        self.main_loop.quit()
637
 
        log.removeHandler(self.loghandler)
638
 
        log.propagate = self.orig_log_propagate
639
 
 
 
630
    
640
631
    def process_input(self, source, condition):
641
632
        keys = self.screen.get_input()
642
 
        translations = {"ctrl n": "down",       # Emacs
643
 
                        "ctrl p": "up",         # Emacs
644
 
                        "ctrl v": "page down",  # Emacs
645
 
                        "meta v": "page up",    # Emacs
646
 
                        " ": "page down",       # less
647
 
                        "f": "page down",       # less
648
 
                        "b": "page up",         # less
649
 
                        "j": "down",            # vi
650
 
                        "k": "up",              # vi
651
 
                        }
 
633
        translations = { "ctrl n": "down",      # Emacs
 
634
                         "ctrl p": "up",        # Emacs
 
635
                         "ctrl v": "page down", # Emacs
 
636
                         "meta v": "page up",   # Emacs
 
637
                         " ": "page down",      # less
 
638
                         "f": "page down",      # less
 
639
                         "b": "page up",        # less
 
640
                         "j": "down",           # vi
 
641
                         "k": "up",             # vi
 
642
                         }
652
643
        for key in keys:
653
644
            try:
654
645
                key = translations[key]
655
646
            except KeyError:    # :-)
656
647
                pass
657
 
 
 
648
            
658
649
            if key == "q" or key == "Q":
659
650
                self.stop()
660
651
                break
661
652
            elif key == "window resize":
662
653
                self.size = self.screen.get_cols_rows()
663
654
                self.refresh()
664
 
            elif key == "ctrl l":
665
 
                self.screen.clear()
 
655
            elif key == "\f":  # Ctrl-L
666
656
                self.refresh()
667
657
            elif key == "l" or key == "D":
668
658
                self.toggle_log_display()
674
664
                if not self.log_visible:
675
665
                    self.log_visible = True
676
666
                    self.rebuild()
677
 
                self.add_log_line(("bold",
678
 
                                   "  ".join(("q: Quit",
679
 
                                              "?: Help",
680
 
                                              "l: Log window toggle",
681
 
                                              "TAB: Switch window",
682
 
                                              "w: Wrap (log lines)",
683
 
                                              "v: Toggle verbose log",
684
 
                                   ))))
685
 
                self.add_log_line(("bold",
686
 
                                   "  ".join(("Clients:",
687
 
                                              "+: Enable",
688
 
                                              "-: Disable",
689
 
                                              "R: Remove",
690
 
                                              "s: Start new checker",
691
 
                                              "S: Stop checker",
692
 
                                              "C: Checker OK",
693
 
                                              "a: Approve",
694
 
                                              "d: Deny",
695
 
                                   ))))
 
667
                self.log_message_raw(("bold",
 
668
                                      "  ".
 
669
                                      join(("q: Quit",
 
670
                                            "?: Help",
 
671
                                            "l: Log window toggle",
 
672
                                            "TAB: Switch window",
 
673
                                            "w: Wrap (log)"))))
 
674
                self.log_message_raw(("bold",
 
675
                                      "  "
 
676
                                      .join(("Clients:",
 
677
                                             "+: Enable",
 
678
                                             "-: Disable",
 
679
                                             "R: Remove",
 
680
                                             "s: Start new checker",
 
681
                                             "S: Stop checker",
 
682
                                             "C: Checker OK",
 
683
                                             "a: Approve",
 
684
                                             "d: Deny"))))
696
685
                self.refresh()
697
686
            elif key == "tab":
698
687
                if self.topwidget.get_focus() is self.logbox:
700
689
                else:
701
690
                    self.topwidget.set_focus(self.logbox)
702
691
                self.refresh()
703
 
            elif key == "v":
704
 
                if log.level < logging.INFO:
705
 
                    log.setLevel(logging.INFO)
706
 
                    log.info("Verbose mode: Off")
707
 
                else:
708
 
                    log.setLevel(logging.NOTSET)
709
 
                    log.info("Verbose mode: On")
710
 
            # elif (key == "end" or key == "meta >" or key == "G"
711
 
            #       or key == ">"):
712
 
            #     pass            # xxx end-of-buffer
713
 
            # elif (key == "home" or key == "meta <" or key == "g"
714
 
            #       or key == "<"):
715
 
            #     pass            # xxx beginning-of-buffer
716
 
            # elif key == "ctrl e" or key == "$":
717
 
            #     pass            # xxx move-end-of-line
718
 
            # elif key == "ctrl a" or key == "^":
719
 
            #     pass            # xxx move-beginning-of-line
720
 
            # elif key == "ctrl b" or key == "meta (" or key == "h":
721
 
            #     pass            # xxx left
722
 
            # elif key == "ctrl f" or key == "meta )" or key == "l":
723
 
            #     pass            # xxx right
724
 
            # elif key == "a":
725
 
            #     pass            # scroll up log
726
 
            # elif key == "z":
727
 
            #     pass            # scroll down log
 
692
            #elif (key == "end" or key == "meta >" or key == "G"
 
693
            #      or key == ">"):
 
694
            #    pass            # xxx end-of-buffer
 
695
            #elif (key == "home" or key == "meta <" or key == "g"
 
696
            #      or key == "<"):
 
697
            #    pass            # xxx beginning-of-buffer
 
698
            #elif key == "ctrl e" or key == "$":
 
699
            #    pass            # xxx move-end-of-line
 
700
            #elif key == "ctrl a" or key == "^":
 
701
            #    pass            # xxx move-beginning-of-line
 
702
            #elif key == "ctrl b" or key == "meta (" or key == "h":
 
703
            #    pass            # xxx left
 
704
            #elif key == "ctrl f" or key == "meta )" or key == "l":
 
705
            #    pass            # xxx right
 
706
            #elif key == "a":
 
707
            #    pass            # scroll up log
 
708
            #elif key == "z":
 
709
            #    pass            # scroll down log
728
710
            elif self.topwidget.selectable():
729
711
                self.topwidget.keypress(self.size, key)
730
712
                self.refresh()
731
713
        return True
732
714
 
733
 
 
734
 
class UILogHandler(logging.Handler):
735
 
    def __init__(self, ui, *args, **kwargs):
736
 
        self.ui = ui
737
 
        super(UILogHandler, self).__init__(*args, **kwargs)
738
 
        self.setFormatter(
739
 
            logging.Formatter("%(asctime)s: %(message)s"))
740
 
    def emit(self, record):
741
 
        msg = self.format(record)
742
 
        if record.levelno > logging.INFO:
743
 
            msg = ("bold", msg)
744
 
        self.ui.add_log_line(msg)
745
 
 
746
 
 
747
715
ui = UserInterface()
748
716
try:
749
717
    ui.run()
750
718
except KeyboardInterrupt:
751
 
    with warnings.catch_warnings():
752
 
        warnings.filterwarnings("ignore", "", BytesWarning)
753
 
        ui.screen.stop()
754
 
except Exception:
755
 
    with warnings.catch_warnings():
756
 
        warnings.filterwarnings("ignore", "", BytesWarning)
757
 
        ui.screen.stop()
 
719
    ui.screen.stop()
 
720
except Exception as e:
 
721
    ui.log_message(str(e))
 
722
    ui.screen.stop()
758
723
    raise