/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: 2019-02-09 23:23:26 UTC
  • Revision ID: teddy@recompile.se-20190209232326-z1z2kzpgfixz7iaj
Add support for using raw public keys in TLS (RFC 7250)

Since GnuTLS removed support for OpenPGP keys in TLS (RFC 6091), and
no other library supports it, we have to change the protocol to use
something else.  We choose to use "raw public keys" (RFC 7250).  Since
we still use OpenPGP keys to decrypt the secret password, this means
that each client will have two keys: One OpenPGP key and one TLS
public/private key, and the key ID of the latter key is used to
identify clients instead of the fingerprint of the OpenPGP key.

Note that this code is still compatible with GnuTLS before version
3.6.0 (when OpenPGP key support was removed).  This commit merely adds
support for using raw pulic keys instead with GnuTLS 3.6.6. or later.

* DBUS-API (Signals/ClientNotFound): Change name of first parameter
                                     from "Fingerprint" to "KeyID".
  (Mandos Client Interface/Properties/KeyID): New.
* INSTALL: Document conflict with GnuTLS 3.6.0 (which removed OpenPGP
           key support) up until 3.6.6, when support for raw public
           keys was added.  Also document new dependency of client on
           "gnutls-bin" package (for certtool).
* Makefile (run-client): Depend on TLS key files, and also pass them
                         as arguments to client.
  (keydir/tls-privkey.pem, keydir/tls-pubkey.pem): New.
  (confdir/clients.conf): Add dependency on TLS public key.
  (purge-client): Add removal of TLS key files.
* clients.conf ([foo]/key_id, [bar]/key_id): New.
* debian/control (Source: mandos/Build-Depends): Also allow
                                                 libgnutls30 (>= 3.6.6)
  (Package: mandos/Depends): - '' -
  (Package: mandos/Description): Alter description to match new
                                 design.
  (Package: mandos-client/Description): - '' -
  (Package: mandos-client/Depends): Move "gnutls-bin | openssl" to
                                    here from "Recommends".
* debian/mandos-client.README.Debian: Add --tls-privkey and
                                      --tls-pubkey options to test
                                      command.
* debian/mandos-client.postinst (create_key): Renamed to "create_keys"
                                             (all callers changed),
                                             and also create TLS key.
* debian/mandos-client.postrm (purge): Also remove TLS key files.
* intro.xml (DESCRIPTION): Describe new dual-key design.
* mandos (GnuTLS): Define different functions depending on whether
                   support for raw public keys is detected.
  (Client.key_id): New attribute.
  (ClientDBus.KeyID_dbus_property): New method.
  (ProxyClient.__init__): Take new "key_id" parameter.
  (ClientHandler.handle): Use key IDs when using raw public keys and
                          use fingerprints when using OpenPGP keys.
  (ClientHandler.peer_certificate): Also handle raw public keys.
  (ClientHandler.key_id): New.
  (MandosServer.handle_ipc): Pass key ID over the pipe IPC.  Also
                             check for key ID matches when looking up
                             clients.
  (main): Default GnuTLS priority string depends on whether we are
          using raw public keys or not.  When unpickling clients, set
          key_id if not set in the pickle.
  (main/MandosDBusService.ClientNotFound): Change name of first
                                           parameter from
                                           "Fingerprint" to "KeyID".
* mandos-clients.conf.xml (OPTIONS): Document new "key_id" option.
  (OPTIONS/secret): Mention new key ID matchning.
  (EXPANSION/RUNTIME EXPANSION): Add new "key_id" option.
  (EXAMPLE): - '' -
* mandos-ctl (tablewords, main/keywords): Add new "KeyID" property.
* mandos-keygen: Create TLS key files.  New "--tls-keytype" (-T)
                 option.  Alter help text to be more clear about key
                 types.  When in password mode, also output "key_id"
                 option.
* mandos-keygen.xml (SYNOPSIS): Add new "--tls-keytype" (-T) option.
  (DESCRIPTION): Alter to match new dual-key design.
  (OVERVIEW): - '' -
  (FILES): Add TLS key files.
* mandos-options.xml (priority): Document new default priority string
                                 when using raw public keys.
* mandos.xml (NETWORK PROTOCOL): Describe new protocol using key ID.
  (BUGS): Remove issue about checking expire times of OpenPGP keys,
          since TLS public keys do not have expiration times.
  (SECURITY/CLIENT): Alter description to match new design.
  (SEE ALSO/GnuTLS): - '' -
  (SEE ALSO): Add reference to RFC 7250, and alter description of when
              RFC 6091 is used.
* overview.xml: Alter text to match new design.
* plugin-runner.xml (EXAMPLE): Add --tls-pubkey and --tls-privkey
                               options to mandos-client options.
* plugins.d/mandos-client.c: Use raw public keys when compiling with
                             supporting GnuTLS versions. Add new
                             "--tls-pubkey" and "--tls-privkey"
                             options (which do nothing if GnuTLS
                             library does not support raw public
                             keys).  Alter text throughout to reflect
                             new design.  Only generate new DH
                             parameters (based on size of OpenPGP key)
                             when using OpenPGP in TLS.  Default
                             GnuTLS priority string depends on whether
                             we are using raw public keys or not.
* plugins.d/mandos-client.xml (SYNOPSIS): Add new "--tls-privkey" (-t)
                                          and "--tls-pubkey" (-T)
                                          options.
  (DESCRIPTION): Describe new dual-key design.
  (OPTIONS): Document new "--tls-privkey" (-t) and "--tls-pubkey" (-T)
             options.
  (OPTIONS/--dh-bits): No longer necessarily depends on OpenPGP key
                       size.
  (FILES): Add default locations for TLS public and private key files.
  (EXAMPLE): Use new --tls-pubkey and --tls-privkey options.
  (SECURITY): Alter wording slightly to reflect new dual-key design.
  (SEE ALSO/GnuTLS): Alter description to match new design.
  (SEE ALSO): Add reference to RFC 7250, and alter description of when
              RFC 6091 is used.

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