/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

  • Committer: Teddy Hogeborn
  • Date: 2019-02-09 23:23:26 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 370.
  • 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
1
 
#!/usr/bin/python2.7
 
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
 
# 
 
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
 
# 
 
5
#
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>.  This includes the
9
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
12
 
# 
 
12
#
13
13
# Everything else is
14
 
# Copyright © 2008-2015 Teddy Hogeborn
15
 
# Copyright © 2008-2015 Björn Påhlsson
16
 
# 
17
 
# This program is free software: you can redistribute it and/or modify
18
 
# it under the terms of the GNU General Public License as published by
 
14
# Copyright © 2008-2018 Teddy Hogeborn
 
15
# Copyright © 2008-2018 Björn Påhlsson
 
16
#
 
17
# This file is part of Mandos.
 
18
#
 
19
# Mandos is free software: you can redistribute it and/or modify it
 
20
# under the terms of the GNU General Public License as published by
19
21
# the Free Software Foundation, either version 3 of the License, or
20
22
# (at your option) any later version.
21
23
#
22
 
#     This program is distributed in the hope that it will be useful,
23
 
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
24
#     Mandos is distributed in the hope that it will be useful, but
 
25
#     WITHOUT ANY WARRANTY; without even the implied warranty of
24
26
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25
27
#     GNU General Public License for more details.
26
 
# 
 
28
#
27
29
# You should have received a copy of the GNU General Public License
28
 
# along with this program.  If not, see
29
 
# <http://www.gnu.org/licenses/>.
30
 
# 
 
30
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
31
#
31
32
# Contact the authors at <mandos@recompile.se>.
32
 
# 
 
33
#
33
34
 
34
35
from __future__ import (division, absolute_import, print_function,
35
36
                        unicode_literals)
36
37
 
37
 
from future_builtins import *
 
38
try:
 
39
    from future_builtins import *
 
40
except ImportError:
 
41
    pass
38
42
 
39
43
try:
40
44
    import SocketServer as socketserver
44
48
import argparse
45
49
import datetime
46
50
import errno
47
 
import gnutls.crypto
48
 
import gnutls.connection
49
 
import gnutls.errors
50
 
import gnutls.library.functions
51
 
import gnutls.library.constants
52
 
import gnutls.library.types
53
51
try:
54
52
    import ConfigParser as configparser
55
53
except ImportError:
82
80
 
83
81
import dbus
84
82
import dbus.service
85
 
try:
86
 
    import gobject
87
 
except ImportError:
88
 
    from gi.repository import GObject as gobject
89
 
import avahi
 
83
from gi.repository import GLib
90
84
from dbus.mainloop.glib import DBusGMainLoop
91
85
import ctypes
92
86
import ctypes.util
93
87
import xml.dom.minidom
94
88
import inspect
95
89
 
 
90
# Try to find the value of SO_BINDTODEVICE:
96
91
try:
 
92
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
 
93
    # newer, and it is also the most natural place for it:
97
94
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
98
95
except AttributeError:
99
96
    try:
 
97
        # This is where SO_BINDTODEVICE was up to and including Python
 
98
        # 2.6, and also 3.2:
100
99
        from IN import SO_BINDTODEVICE
101
100
    except ImportError:
102
 
        SO_BINDTODEVICE = None
 
101
        # In Python 2.7 it seems to have been removed entirely.
 
102
        # Try running the C preprocessor:
 
103
        try:
 
104
            cc = subprocess.Popen(["cc", "--language=c", "-E",
 
105
                                   "/dev/stdin"],
 
106
                                  stdin=subprocess.PIPE,
 
107
                                  stdout=subprocess.PIPE)
 
108
            stdout = cc.communicate(
 
109
                "#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
 
110
            SO_BINDTODEVICE = int(stdout.splitlines()[-1])
 
111
        except (OSError, ValueError, IndexError):
 
112
            # No value found
 
113
            SO_BINDTODEVICE = None
103
114
 
104
115
if sys.version_info.major == 2:
105
116
    str = unicode
106
117
 
107
 
version = "1.6.9"
 
118
version = "1.7.20"
108
119
stored_state_file = "clients.pickle"
109
120
 
110
121
logger = logging.getLogger()
114
125
    if_nametoindex = ctypes.cdll.LoadLibrary(
115
126
        ctypes.util.find_library("c")).if_nametoindex
116
127
except (OSError, AttributeError):
117
 
    
 
128
 
118
129
    def if_nametoindex(interface):
119
130
        "Get an interface index the hard way, i.e. using fcntl()"
120
131
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
125
136
        return interface_index
126
137
 
127
138
 
 
139
def copy_function(func):
 
140
    """Make a copy of a function"""
 
141
    if sys.version_info.major == 2:
 
142
        return types.FunctionType(func.func_code,
 
143
                                  func.func_globals,
 
144
                                  func.func_name,
 
145
                                  func.func_defaults,
 
146
                                  func.func_closure)
 
147
    else:
 
148
        return types.FunctionType(func.__code__,
 
149
                                  func.__globals__,
 
150
                                  func.__name__,
 
151
                                  func.__defaults__,
 
152
                                  func.__closure__)
 
153
 
 
154
 
128
155
def initlogger(debug, level=logging.WARNING):
129
156
    """init logger and add loglevel"""
130
 
    
 
157
 
131
158
    global syslogger
132
159
    syslogger = (logging.handlers.SysLogHandler(
133
 
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
134
 
        address = "/dev/log"))
 
160
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
 
161
        address="/dev/log"))
135
162
    syslogger.setFormatter(logging.Formatter
136
163
                           ('Mandos [%(process)d]: %(levelname)s:'
137
164
                            ' %(message)s'))
138
165
    logger.addHandler(syslogger)
139
 
    
 
166
 
140
167
    if debug:
141
168
        console = logging.StreamHandler()
142
169
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
154
181
 
155
182
class PGPEngine(object):
156
183
    """A simple class for OpenPGP symmetric encryption & decryption"""
157
 
    
 
184
 
158
185
    def __init__(self):
159
186
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
187
        self.gpg = "gpg"
 
188
        try:
 
189
            output = subprocess.check_output(["gpgconf"])
 
190
            for line in output.splitlines():
 
191
                name, text, path = line.split(b":")
 
192
                if name == "gpg":
 
193
                    self.gpg = path
 
194
                    break
 
195
        except OSError as e:
 
196
            if e.errno != errno.ENOENT:
 
197
                raise
160
198
        self.gnupgargs = ['--batch',
161
 
                          '--home', self.tempdir,
 
199
                          '--homedir', self.tempdir,
162
200
                          '--force-mdc',
163
 
                          '--quiet',
164
 
                          '--no-use-agent']
165
 
    
 
201
                          '--quiet']
 
202
        # Only GPG version 1 has the --no-use-agent option.
 
203
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
 
204
            self.gnupgargs.append("--no-use-agent")
 
205
 
166
206
    def __enter__(self):
167
207
        return self
168
 
    
 
208
 
169
209
    def __exit__(self, exc_type, exc_value, traceback):
170
210
        self._cleanup()
171
211
        return False
172
 
    
 
212
 
173
213
    def __del__(self):
174
214
        self._cleanup()
175
 
    
 
215
 
176
216
    def _cleanup(self):
177
217
        if self.tempdir is not None:
178
218
            # Delete contents of tempdir
179
219
            for root, dirs, files in os.walk(self.tempdir,
180
 
                                             topdown = False):
 
220
                                             topdown=False):
181
221
                for filename in files:
182
222
                    os.remove(os.path.join(root, filename))
183
223
                for dirname in dirs:
185
225
            # Remove tempdir
186
226
            os.rmdir(self.tempdir)
187
227
            self.tempdir = None
188
 
    
 
228
 
189
229
    def password_encode(self, password):
190
230
        # Passphrase can not be empty and can not contain newlines or
191
231
        # NUL bytes.  So we prefix it and hex encode it.
196
236
                       .replace(b"\n", b"\\n")
197
237
                       .replace(b"\0", b"\\x00"))
198
238
        return encoded
199
 
    
 
239
 
200
240
    def encrypt(self, data, password):
201
241
        passphrase = self.password_encode(password)
202
242
        with tempfile.NamedTemporaryFile(
203
243
                dir=self.tempdir) as passfile:
204
244
            passfile.write(passphrase)
205
245
            passfile.flush()
206
 
            proc = subprocess.Popen(['gpg', '--symmetric',
 
246
            proc = subprocess.Popen([self.gpg, '--symmetric',
207
247
                                     '--passphrase-file',
208
248
                                     passfile.name]
209
249
                                    + self.gnupgargs,
210
 
                                    stdin = subprocess.PIPE,
211
 
                                    stdout = subprocess.PIPE,
212
 
                                    stderr = subprocess.PIPE)
213
 
            ciphertext, err = proc.communicate(input = data)
 
250
                                    stdin=subprocess.PIPE,
 
251
                                    stdout=subprocess.PIPE,
 
252
                                    stderr=subprocess.PIPE)
 
253
            ciphertext, err = proc.communicate(input=data)
214
254
        if proc.returncode != 0:
215
255
            raise PGPError(err)
216
256
        return ciphertext
217
 
    
 
257
 
218
258
    def decrypt(self, data, password):
219
259
        passphrase = self.password_encode(password)
220
260
        with tempfile.NamedTemporaryFile(
221
 
                dir = self.tempdir) as passfile:
 
261
                dir=self.tempdir) as passfile:
222
262
            passfile.write(passphrase)
223
263
            passfile.flush()
224
 
            proc = subprocess.Popen(['gpg', '--decrypt',
 
264
            proc = subprocess.Popen([self.gpg, '--decrypt',
225
265
                                     '--passphrase-file',
226
266
                                     passfile.name]
227
267
                                    + self.gnupgargs,
228
 
                                    stdin = subprocess.PIPE,
229
 
                                    stdout = subprocess.PIPE,
230
 
                                    stderr = subprocess.PIPE)
231
 
            decrypted_plaintext, err = proc.communicate(input = data)
 
268
                                    stdin=subprocess.PIPE,
 
269
                                    stdout=subprocess.PIPE,
 
270
                                    stderr=subprocess.PIPE)
 
271
            decrypted_plaintext, err = proc.communicate(input=data)
232
272
        if proc.returncode != 0:
233
273
            raise PGPError(err)
234
274
        return decrypted_plaintext
235
275
 
236
276
 
 
277
# Pretend that we have an Avahi module
 
278
class Avahi(object):
 
279
    """This isn't so much a class as it is a module-like namespace.
 
280
    It is instantiated once, and simulates having an Avahi module."""
 
281
    IF_UNSPEC = -1               # avahi-common/address.h
 
282
    PROTO_UNSPEC = -1            # avahi-common/address.h
 
283
    PROTO_INET = 0               # avahi-common/address.h
 
284
    PROTO_INET6 = 1              # avahi-common/address.h
 
285
    DBUS_NAME = "org.freedesktop.Avahi"
 
286
    DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
 
287
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
 
288
    DBUS_PATH_SERVER = "/"
 
289
 
 
290
    def string_array_to_txt_array(self, t):
 
291
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
 
292
                           for s in t), signature="ay")
 
293
    ENTRY_GROUP_ESTABLISHED = 2  # avahi-common/defs.h
 
294
    ENTRY_GROUP_COLLISION = 3    # avahi-common/defs.h
 
295
    ENTRY_GROUP_FAILURE = 4      # avahi-common/defs.h
 
296
    SERVER_INVALID = 0           # avahi-common/defs.h
 
297
    SERVER_REGISTERING = 1       # avahi-common/defs.h
 
298
    SERVER_RUNNING = 2           # avahi-common/defs.h
 
299
    SERVER_COLLISION = 3         # avahi-common/defs.h
 
300
    SERVER_FAILURE = 4           # avahi-common/defs.h
 
301
avahi = Avahi()
 
302
 
 
303
 
237
304
class AvahiError(Exception):
238
305
    def __init__(self, value, *args, **kwargs):
239
306
        self.value = value
251
318
 
252
319
class AvahiService(object):
253
320
    """An Avahi (Zeroconf) service.
254
 
    
 
321
 
255
322
    Attributes:
256
323
    interface: integer; avahi.IF_UNSPEC or an interface index.
257
324
               Used to optionally bind to the specified interface.
269
336
    server: D-Bus Server
270
337
    bus: dbus.SystemBus()
271
338
    """
272
 
    
 
339
 
273
340
    def __init__(self,
274
 
                 interface = avahi.IF_UNSPEC,
275
 
                 name = None,
276
 
                 servicetype = None,
277
 
                 port = None,
278
 
                 TXT = None,
279
 
                 domain = "",
280
 
                 host = "",
281
 
                 max_renames = 32768,
282
 
                 protocol = avahi.PROTO_UNSPEC,
283
 
                 bus = None):
 
341
                 interface=avahi.IF_UNSPEC,
 
342
                 name=None,
 
343
                 servicetype=None,
 
344
                 port=None,
 
345
                 TXT=None,
 
346
                 domain="",
 
347
                 host="",
 
348
                 max_renames=32768,
 
349
                 protocol=avahi.PROTO_UNSPEC,
 
350
                 bus=None):
284
351
        self.interface = interface
285
352
        self.name = name
286
353
        self.type = servicetype
295
362
        self.server = None
296
363
        self.bus = bus
297
364
        self.entry_group_state_changed_match = None
298
 
    
 
365
 
299
366
    def rename(self, remove=True):
300
367
        """Derived from the Avahi example code"""
301
368
        if self.rename_count >= self.max_renames:
321
388
                logger.critical("D-Bus Exception", exc_info=error)
322
389
                self.cleanup()
323
390
                os._exit(1)
324
 
    
 
391
 
325
392
    def remove(self):
326
393
        """Derived from the Avahi example code"""
327
394
        if self.entry_group_state_changed_match is not None:
329
396
            self.entry_group_state_changed_match = None
330
397
        if self.group is not None:
331
398
            self.group.Reset()
332
 
    
 
399
 
333
400
    def add(self):
334
401
        """Derived from the Avahi example code"""
335
402
        self.remove()
352
419
            dbus.UInt16(self.port),
353
420
            avahi.string_array_to_txt_array(self.TXT))
354
421
        self.group.Commit()
355
 
    
 
422
 
356
423
    def entry_group_state_changed(self, state, error):
357
424
        """Derived from the Avahi example code"""
358
425
        logger.debug("Avahi entry group state change: %i", state)
359
 
        
 
426
 
360
427
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
361
428
            logger.debug("Zeroconf service established.")
362
429
        elif state == avahi.ENTRY_GROUP_COLLISION:
366
433
            logger.critical("Avahi: Error in group state changed %s",
367
434
                            str(error))
368
435
            raise AvahiGroupError("State changed: {!s}".format(error))
369
 
    
 
436
 
370
437
    def cleanup(self):
371
438
        """Derived from the Avahi example code"""
372
439
        if self.group is not None:
377
444
                pass
378
445
            self.group = None
379
446
        self.remove()
380
 
    
 
447
 
381
448
    def server_state_changed(self, state, error=None):
382
449
        """Derived from the Avahi example code"""
383
450
        logger.debug("Avahi server state change: %i", state)
395
462
                    logger.error(bad_states[state] + ": %r", error)
396
463
            self.cleanup()
397
464
        elif state == avahi.SERVER_RUNNING:
398
 
            self.add()
 
465
            try:
 
466
                self.add()
 
467
            except dbus.exceptions.DBusException as error:
 
468
                if (error.get_dbus_name()
 
469
                    == "org.freedesktop.Avahi.CollisionError"):
 
470
                    logger.info("Local Zeroconf service name"
 
471
                                " collision.")
 
472
                    return self.rename(remove=False)
 
473
                else:
 
474
                    logger.critical("D-Bus Exception", exc_info=error)
 
475
                    self.cleanup()
 
476
                    os._exit(1)
399
477
        else:
400
478
            if error is None:
401
479
                logger.debug("Unknown state: %r", state)
402
480
            else:
403
481
                logger.debug("Unknown state: %r: %r", state, error)
404
 
    
 
482
 
405
483
    def activate(self):
406
484
        """Derived from the Avahi example code"""
407
485
        if self.server is None:
418
496
class AvahiServiceToSyslog(AvahiService):
419
497
    def rename(self, *args, **kwargs):
420
498
        """Add the new name to the syslog messages"""
421
 
        ret = AvahiService.rename(self, *args, **kwargs)
 
499
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
422
500
        syslogger.setFormatter(logging.Formatter(
423
501
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
424
502
            .format(self.name)))
425
503
        return ret
426
504
 
 
505
 
 
506
# Pretend that we have a GnuTLS module
 
507
class GnuTLS(object):
 
508
    """This isn't so much a class as it is a module-like namespace.
 
509
    It is instantiated once, and simulates having a GnuTLS module."""
 
510
 
 
511
    library = ctypes.util.find_library("gnutls")
 
512
    if library is None:
 
513
        library = ctypes.util.find_library("gnutls-deb0")
 
514
    _library = ctypes.cdll.LoadLibrary(library)
 
515
    del library
 
516
    _need_version = b"3.3.0"
 
517
    _tls_rawpk_version = b"3.6.6"
 
518
 
 
519
    def __init__(self):
 
520
        # Need to use "self" here, since this method is called before
 
521
        # the assignment to the "gnutls" global variable happens.
 
522
        if self.check_version(self._need_version) is None:
 
523
            raise self.Error("Needs GnuTLS {} or later"
 
524
                             .format(self._need_version))
 
525
 
 
526
    # Unless otherwise indicated, the constants and types below are
 
527
    # all from the gnutls/gnutls.h C header file.
 
528
 
 
529
    # Constants
 
530
    E_SUCCESS = 0
 
531
    E_INTERRUPTED = -52
 
532
    E_AGAIN = -28
 
533
    CRT_OPENPGP = 2
 
534
    CRT_RAWPK = 3
 
535
    CLIENT = 2
 
536
    SHUT_RDWR = 0
 
537
    CRD_CERTIFICATE = 1
 
538
    E_NO_CERTIFICATE_FOUND = -49
 
539
    X509_FMT_DER = 0
 
540
    NO_TICKETS = 1<<10
 
541
    ENABLE_RAWPK = 1<<18
 
542
    CTYPE_PEERS = 3
 
543
    KEYID_USE_SHA256 = 1        # gnutls/x509.h
 
544
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
 
545
 
 
546
    # Types
 
547
    class session_int(ctypes.Structure):
 
548
        _fields_ = []
 
549
    session_t = ctypes.POINTER(session_int)
 
550
 
 
551
    class certificate_credentials_st(ctypes.Structure):
 
552
        _fields_ = []
 
553
    certificate_credentials_t = ctypes.POINTER(
 
554
        certificate_credentials_st)
 
555
    certificate_type_t = ctypes.c_int
 
556
 
 
557
    class datum_t(ctypes.Structure):
 
558
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
559
                    ('size', ctypes.c_uint)]
 
560
 
 
561
    class openpgp_crt_int(ctypes.Structure):
 
562
        _fields_ = []
 
563
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
564
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
 
565
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
 
566
    credentials_type_t = ctypes.c_int
 
567
    transport_ptr_t = ctypes.c_void_p
 
568
    close_request_t = ctypes.c_int
 
569
 
 
570
    # Exceptions
 
571
    class Error(Exception):
 
572
        # We need to use the class name "GnuTLS" here, since this
 
573
        # exception might be raised from within GnuTLS.__init__,
 
574
        # which is called before the assignment to the "gnutls"
 
575
        # global variable has happened.
 
576
        def __init__(self, message=None, code=None, args=()):
 
577
            # Default usage is by a message string, but if a return
 
578
            # code is passed, convert it to a string with
 
579
            # gnutls.strerror()
 
580
            self.code = code
 
581
            if message is None and code is not None:
 
582
                message = GnuTLS.strerror(code)
 
583
            return super(GnuTLS.Error, self).__init__(
 
584
                message, *args)
 
585
 
 
586
    class CertificateSecurityError(Error):
 
587
        pass
 
588
 
 
589
    # Classes
 
590
    class Credentials(object):
 
591
        def __init__(self):
 
592
            self._c_object = gnutls.certificate_credentials_t()
 
593
            gnutls.certificate_allocate_credentials(
 
594
                ctypes.byref(self._c_object))
 
595
            self.type = gnutls.CRD_CERTIFICATE
 
596
 
 
597
        def __del__(self):
 
598
            gnutls.certificate_free_credentials(self._c_object)
 
599
 
 
600
    class ClientSession(object):
 
601
        def __init__(self, socket, credentials=None):
 
602
            self._c_object = gnutls.session_t()
 
603
            gnutls_flags = gnutls.CLIENT
 
604
            if gnutls.check_version("3.5.6"):
 
605
                gnutls_flags |= gnutls.NO_TICKETS
 
606
            if gnutls.has_rawpk:
 
607
                gnutls_flags |= gnutls.ENABLE_RAWPK
 
608
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
 
609
            del gnutls_flags
 
610
            gnutls.set_default_priority(self._c_object)
 
611
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
612
            gnutls.handshake_set_private_extensions(self._c_object,
 
613
                                                    True)
 
614
            self.socket = socket
 
615
            if credentials is None:
 
616
                credentials = gnutls.Credentials()
 
617
            gnutls.credentials_set(self._c_object, credentials.type,
 
618
                                   ctypes.cast(credentials._c_object,
 
619
                                               ctypes.c_void_p))
 
620
            self.credentials = credentials
 
621
 
 
622
        def __del__(self):
 
623
            gnutls.deinit(self._c_object)
 
624
 
 
625
        def handshake(self):
 
626
            return gnutls.handshake(self._c_object)
 
627
 
 
628
        def send(self, data):
 
629
            data = bytes(data)
 
630
            data_len = len(data)
 
631
            while data_len > 0:
 
632
                data_len -= gnutls.record_send(self._c_object,
 
633
                                               data[-data_len:],
 
634
                                               data_len)
 
635
 
 
636
        def bye(self):
 
637
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
638
 
 
639
    # Error handling functions
 
640
    def _error_code(result):
 
641
        """A function to raise exceptions on errors, suitable
 
642
        for the 'restype' attribute on ctypes functions"""
 
643
        if result >= 0:
 
644
            return result
 
645
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
 
646
            raise gnutls.CertificateSecurityError(code=result)
 
647
        raise gnutls.Error(code=result)
 
648
 
 
649
    def _retry_on_error(result, func, arguments):
 
650
        """A function to retry on some errors, suitable
 
651
        for the 'errcheck' attribute on ctypes functions"""
 
652
        while result < 0:
 
653
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
 
654
                return _error_code(result)
 
655
            result = func(*arguments)
 
656
        return result
 
657
 
 
658
    # Unless otherwise indicated, the function declarations below are
 
659
    # all from the gnutls/gnutls.h C header file.
 
660
 
 
661
    # Functions
 
662
    priority_set_direct = _library.gnutls_priority_set_direct
 
663
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
664
                                    ctypes.POINTER(ctypes.c_char_p)]
 
665
    priority_set_direct.restype = _error_code
 
666
 
 
667
    init = _library.gnutls_init
 
668
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
669
    init.restype = _error_code
 
670
 
 
671
    set_default_priority = _library.gnutls_set_default_priority
 
672
    set_default_priority.argtypes = [session_t]
 
673
    set_default_priority.restype = _error_code
 
674
 
 
675
    record_send = _library.gnutls_record_send
 
676
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
677
                            ctypes.c_size_t]
 
678
    record_send.restype = ctypes.c_ssize_t
 
679
    record_send.errcheck = _retry_on_error
 
680
 
 
681
    certificate_allocate_credentials = (
 
682
        _library.gnutls_certificate_allocate_credentials)
 
683
    certificate_allocate_credentials.argtypes = [
 
684
        ctypes.POINTER(certificate_credentials_t)]
 
685
    certificate_allocate_credentials.restype = _error_code
 
686
 
 
687
    certificate_free_credentials = (
 
688
        _library.gnutls_certificate_free_credentials)
 
689
    certificate_free_credentials.argtypes = [
 
690
        certificate_credentials_t]
 
691
    certificate_free_credentials.restype = None
 
692
 
 
693
    handshake_set_private_extensions = (
 
694
        _library.gnutls_handshake_set_private_extensions)
 
695
    handshake_set_private_extensions.argtypes = [session_t,
 
696
                                                 ctypes.c_int]
 
697
    handshake_set_private_extensions.restype = None
 
698
 
 
699
    credentials_set = _library.gnutls_credentials_set
 
700
    credentials_set.argtypes = [session_t, credentials_type_t,
 
701
                                ctypes.c_void_p]
 
702
    credentials_set.restype = _error_code
 
703
 
 
704
    strerror = _library.gnutls_strerror
 
705
    strerror.argtypes = [ctypes.c_int]
 
706
    strerror.restype = ctypes.c_char_p
 
707
 
 
708
    certificate_type_get = _library.gnutls_certificate_type_get
 
709
    certificate_type_get.argtypes = [session_t]
 
710
    certificate_type_get.restype = _error_code
 
711
 
 
712
    certificate_get_peers = _library.gnutls_certificate_get_peers
 
713
    certificate_get_peers.argtypes = [session_t,
 
714
                                      ctypes.POINTER(ctypes.c_uint)]
 
715
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
 
716
 
 
717
    global_set_log_level = _library.gnutls_global_set_log_level
 
718
    global_set_log_level.argtypes = [ctypes.c_int]
 
719
    global_set_log_level.restype = None
 
720
 
 
721
    global_set_log_function = _library.gnutls_global_set_log_function
 
722
    global_set_log_function.argtypes = [log_func]
 
723
    global_set_log_function.restype = None
 
724
 
 
725
    deinit = _library.gnutls_deinit
 
726
    deinit.argtypes = [session_t]
 
727
    deinit.restype = None
 
728
 
 
729
    handshake = _library.gnutls_handshake
 
730
    handshake.argtypes = [session_t]
 
731
    handshake.restype = _error_code
 
732
    handshake.errcheck = _retry_on_error
 
733
 
 
734
    transport_set_ptr = _library.gnutls_transport_set_ptr
 
735
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
736
    transport_set_ptr.restype = None
 
737
 
 
738
    bye = _library.gnutls_bye
 
739
    bye.argtypes = [session_t, close_request_t]
 
740
    bye.restype = _error_code
 
741
    bye.errcheck = _retry_on_error
 
742
 
 
743
    check_version = _library.gnutls_check_version
 
744
    check_version.argtypes = [ctypes.c_char_p]
 
745
    check_version.restype = ctypes.c_char_p
 
746
 
 
747
    has_rawpk = bool(check_version(_tls_rawpk_version))
 
748
 
 
749
    if has_rawpk:
 
750
        # Types
 
751
        class pubkey_st(ctypes.Structure):
 
752
            _fields = []
 
753
        pubkey_t = ctypes.POINTER(pubkey_st)
 
754
 
 
755
        x509_crt_fmt_t = ctypes.c_int
 
756
 
 
757
        # All the function declarations below are from gnutls/abstract.h
 
758
        pubkey_init = _library.gnutls_pubkey_init
 
759
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
 
760
        pubkey_init.restype = _error_code
 
761
 
 
762
        pubkey_import = _library.gnutls_pubkey_import
 
763
        pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
 
764
                                  x509_crt_fmt_t]
 
765
        pubkey_import.restype = _error_code
 
766
 
 
767
        pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
 
768
        pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
 
769
                                      ctypes.POINTER(ctypes.c_ubyte),
 
770
                                      ctypes.POINTER(ctypes.c_size_t)]
 
771
        pubkey_get_key_id.restype = _error_code
 
772
 
 
773
        pubkey_deinit = _library.gnutls_pubkey_deinit
 
774
        pubkey_deinit.argtypes = [pubkey_t]
 
775
        pubkey_deinit.restype = None
 
776
    else:
 
777
        # All the function declarations below are from gnutls/openpgp.h
 
778
 
 
779
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
780
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
781
        openpgp_crt_init.restype = _error_code
 
782
 
 
783
        openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
784
        openpgp_crt_import.argtypes = [openpgp_crt_t,
 
785
                                       ctypes.POINTER(datum_t),
 
786
                                       openpgp_crt_fmt_t]
 
787
        openpgp_crt_import.restype = _error_code
 
788
 
 
789
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
790
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
791
                                            ctypes.POINTER(ctypes.c_uint)]
 
792
        openpgp_crt_verify_self.restype = _error_code
 
793
 
 
794
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
795
        openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
796
        openpgp_crt_deinit.restype = None
 
797
 
 
798
        openpgp_crt_get_fingerprint = (
 
799
            _library.gnutls_openpgp_crt_get_fingerprint)
 
800
        openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
801
                                                ctypes.c_void_p,
 
802
                                                ctypes.POINTER(
 
803
                                                    ctypes.c_size_t)]
 
804
        openpgp_crt_get_fingerprint.restype = _error_code
 
805
 
 
806
    if check_version("3.6.4"):
 
807
        certificate_type_get2 = _library.gnutls_certificate_type_get2
 
808
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
 
809
        certificate_type_get2.restype = _error_code
 
810
 
 
811
    # Remove non-public functions
 
812
    del _error_code, _retry_on_error
 
813
# Create the global "gnutls" object, simulating a module
 
814
gnutls = GnuTLS()
 
815
 
 
816
 
427
817
def call_pipe(connection,       # : multiprocessing.Connection
428
818
              func, *args, **kwargs):
429
819
    """This function is meant to be called by multiprocessing.Process
430
 
    
 
820
 
431
821
    This function runs func(*args, **kwargs), and writes the resulting
432
822
    return value on the provided multiprocessing.Connection.
433
823
    """
434
824
    connection.send(func(*args, **kwargs))
435
825
    connection.close()
436
826
 
 
827
 
437
828
class Client(object):
438
829
    """A representation of a client host served by this server.
439
 
    
 
830
 
440
831
    Attributes:
441
832
    approved:   bool(); 'None' if not yet approved/disapproved
442
833
    approval_delay: datetime.timedelta(); Time to wait for approval
444
835
    checker:    subprocess.Popen(); a running checker process used
445
836
                                    to see if the client lives.
446
837
                                    'None' if no process is running.
447
 
    checker_callback_tag: a gobject event source tag, or None
 
838
    checker_callback_tag: a GLib event source tag, or None
448
839
    checker_command: string; External command which is run to check
449
840
                     if client lives.  %() expansions are done at
450
841
                     runtime with vars(self) as dict, so that for
451
842
                     instance %(name)s can be used in the command.
452
 
    checker_initiator_tag: a gobject event source tag, or None
 
843
    checker_initiator_tag: a GLib event source tag, or None
453
844
    created:    datetime.datetime(); (UTC) object creation
454
845
    client_structure: Object describing what attributes a client has
455
846
                      and is used for storing the client at exit
456
847
    current_checker_command: string; current running checker_command
457
 
    disable_initiator_tag: a gobject event source tag, or None
 
848
    disable_initiator_tag: a GLib event source tag, or None
458
849
    enabled:    bool()
459
850
    fingerprint: string (40 or 32 hexadecimal digits); used to
460
 
                 uniquely identify the client
 
851
                 uniquely identify an OpenPGP client
 
852
    key_id: string (64 hexadecimal digits); used to uniquely identify
 
853
            a client using raw public keys
461
854
    host:       string; available for use by the checker command
462
855
    interval:   datetime.timedelta(); How often to start a new checker
463
856
    last_approval_request: datetime.datetime(); (UTC) or None
479
872
                disabled, or None
480
873
    server_settings: The server_settings dict from main()
481
874
    """
482
 
    
 
875
 
483
876
    runtime_expansions = ("approval_delay", "approval_duration",
484
 
                          "created", "enabled", "expires",
 
877
                          "created", "enabled", "expires", "key_id",
485
878
                          "fingerprint", "host", "interval",
486
879
                          "last_approval_request", "last_checked_ok",
487
880
                          "last_enabled", "name", "timeout")
496
889
        "approved_by_default": "True",
497
890
        "enabled": "True",
498
891
    }
499
 
    
 
892
 
500
893
    @staticmethod
501
894
    def config_parser(config):
502
895
        """Construct a new dict of client settings of this form:
509
902
        for client_name in config.sections():
510
903
            section = dict(config.items(client_name))
511
904
            client = settings[client_name] = {}
512
 
            
 
905
 
513
906
            client["host"] = section["host"]
514
907
            # Reformat values from string types to Python types
515
908
            client["approved_by_default"] = config.getboolean(
516
909
                client_name, "approved_by_default")
517
910
            client["enabled"] = config.getboolean(client_name,
518
911
                                                  "enabled")
519
 
            
520
 
            # Uppercase and remove spaces from fingerprint for later
521
 
            # comparison purposes with return value from the
522
 
            # fingerprint() function
 
912
 
 
913
            # Uppercase and remove spaces from key_id and fingerprint
 
914
            # for later comparison purposes with return value from the
 
915
            # key_id() and fingerprint() functions
 
916
            client["key_id"] = (section.get("key_id", "").upper()
 
917
                                .replace(" ", ""))
523
918
            client["fingerprint"] = (section["fingerprint"].upper()
524
919
                                     .replace(" ", ""))
525
920
            if "secret" in section:
526
 
                client["secret"] = section["secret"].decode("base64")
 
921
                client["secret"] = codecs.decode(section["secret"]
 
922
                                                 .encode("utf-8"),
 
923
                                                 "base64")
527
924
            elif "secfile" in section:
528
925
                with open(os.path.expanduser(os.path.expandvars
529
926
                                             (section["secfile"])),
544
941
            client["last_approval_request"] = None
545
942
            client["last_checked_ok"] = None
546
943
            client["last_checker_status"] = -2
547
 
        
 
944
 
548
945
        return settings
549
 
    
550
 
    def __init__(self, settings, name = None, server_settings=None):
 
946
 
 
947
    def __init__(self, settings, name=None, server_settings=None):
551
948
        self.name = name
552
949
        if server_settings is None:
553
950
            server_settings = {}
555
952
        # adding all client settings
556
953
        for setting, value in settings.items():
557
954
            setattr(self, setting, value)
558
 
        
 
955
 
559
956
        if self.enabled:
560
957
            if not hasattr(self, "last_enabled"):
561
958
                self.last_enabled = datetime.datetime.utcnow()
565
962
        else:
566
963
            self.last_enabled = None
567
964
            self.expires = None
568
 
        
 
965
 
569
966
        logger.debug("Creating client %r", self.name)
 
967
        logger.debug("  Key ID: %s", self.key_id)
570
968
        logger.debug("  Fingerprint: %s", self.fingerprint)
571
969
        self.created = settings.get("created",
572
970
                                    datetime.datetime.utcnow())
573
 
        
 
971
 
574
972
        # attributes specific for this server instance
575
973
        self.checker = None
576
974
        self.checker_initiator_tag = None
582
980
        self.changedstate = multiprocessing_manager.Condition(
583
981
            multiprocessing_manager.Lock())
584
982
        self.client_structure = [attr
585
 
                                 for attr in self.__dict__.iterkeys()
 
983
                                 for attr in self.__dict__.keys()
586
984
                                 if not attr.startswith("_")]
587
985
        self.client_structure.append("client_structure")
588
 
        
 
986
 
589
987
        for name, t in inspect.getmembers(
590
988
                type(self), lambda obj: isinstance(obj, property)):
591
989
            if not name.startswith("_"):
592
990
                self.client_structure.append(name)
593
 
    
 
991
 
594
992
    # Send notice to process children that client state has changed
595
993
    def send_changedstate(self):
596
994
        with self.changedstate:
597
995
            self.changedstate.notify_all()
598
 
    
 
996
 
599
997
    def enable(self):
600
998
        """Start this client's checker and timeout hooks"""
601
999
        if getattr(self, "enabled", False):
606
1004
        self.last_enabled = datetime.datetime.utcnow()
607
1005
        self.init_checker()
608
1006
        self.send_changedstate()
609
 
    
 
1007
 
610
1008
    def disable(self, quiet=True):
611
1009
        """Disable this client."""
612
1010
        if not getattr(self, "enabled", False):
614
1012
        if not quiet:
615
1013
            logger.info("Disabling client %s", self.name)
616
1014
        if getattr(self, "disable_initiator_tag", None) is not None:
617
 
            gobject.source_remove(self.disable_initiator_tag)
 
1015
            GLib.source_remove(self.disable_initiator_tag)
618
1016
            self.disable_initiator_tag = None
619
1017
        self.expires = None
620
1018
        if getattr(self, "checker_initiator_tag", None) is not None:
621
 
            gobject.source_remove(self.checker_initiator_tag)
 
1019
            GLib.source_remove(self.checker_initiator_tag)
622
1020
            self.checker_initiator_tag = None
623
1021
        self.stop_checker()
624
1022
        self.enabled = False
625
1023
        if not quiet:
626
1024
            self.send_changedstate()
627
 
        # Do not run this again if called by a gobject.timeout_add
 
1025
        # Do not run this again if called by a GLib.timeout_add
628
1026
        return False
629
 
    
 
1027
 
630
1028
    def __del__(self):
631
1029
        self.disable()
632
 
    
 
1030
 
633
1031
    def init_checker(self):
634
1032
        # Schedule a new checker to be started an 'interval' from now,
635
1033
        # and every interval from then on.
636
1034
        if self.checker_initiator_tag is not None:
637
 
            gobject.source_remove(self.checker_initiator_tag)
638
 
        self.checker_initiator_tag = gobject.timeout_add(
 
1035
            GLib.source_remove(self.checker_initiator_tag)
 
1036
        self.checker_initiator_tag = GLib.timeout_add(
639
1037
            int(self.interval.total_seconds() * 1000),
640
1038
            self.start_checker)
641
1039
        # Schedule a disable() when 'timeout' has passed
642
1040
        if self.disable_initiator_tag is not None:
643
 
            gobject.source_remove(self.disable_initiator_tag)
644
 
        self.disable_initiator_tag = gobject.timeout_add(
 
1041
            GLib.source_remove(self.disable_initiator_tag)
 
1042
        self.disable_initiator_tag = GLib.timeout_add(
645
1043
            int(self.timeout.total_seconds() * 1000), self.disable)
646
1044
        # Also start a new checker *right now*.
647
1045
        self.start_checker()
648
 
    
 
1046
 
649
1047
    def checker_callback(self, source, condition, connection,
650
1048
                         command):
651
1049
        """The checker has completed, so take appropriate actions."""
654
1052
        # Read return code from connection (see call_pipe)
655
1053
        returncode = connection.recv()
656
1054
        connection.close()
657
 
        
 
1055
 
658
1056
        if returncode >= 0:
659
1057
            self.last_checker_status = returncode
660
1058
            self.last_checker_signal = None
670
1068
            logger.warning("Checker for %(name)s crashed?",
671
1069
                           vars(self))
672
1070
        return False
673
 
    
 
1071
 
674
1072
    def checked_ok(self):
675
1073
        """Assert that the client has been seen, alive and well."""
676
1074
        self.last_checked_ok = datetime.datetime.utcnow()
677
1075
        self.last_checker_status = 0
678
1076
        self.last_checker_signal = None
679
1077
        self.bump_timeout()
680
 
    
 
1078
 
681
1079
    def bump_timeout(self, timeout=None):
682
1080
        """Bump up the timeout for this client."""
683
1081
        if timeout is None:
684
1082
            timeout = self.timeout
685
1083
        if self.disable_initiator_tag is not None:
686
 
            gobject.source_remove(self.disable_initiator_tag)
 
1084
            GLib.source_remove(self.disable_initiator_tag)
687
1085
            self.disable_initiator_tag = None
688
1086
        if getattr(self, "enabled", False):
689
 
            self.disable_initiator_tag = gobject.timeout_add(
 
1087
            self.disable_initiator_tag = GLib.timeout_add(
690
1088
                int(timeout.total_seconds() * 1000), self.disable)
691
1089
            self.expires = datetime.datetime.utcnow() + timeout
692
 
    
 
1090
 
693
1091
    def need_approval(self):
694
1092
        self.last_approval_request = datetime.datetime.utcnow()
695
 
    
 
1093
 
696
1094
    def start_checker(self):
697
1095
        """Start a new checker subprocess if one is not running.
698
 
        
 
1096
 
699
1097
        If a checker already exists, leave it running and do
700
1098
        nothing."""
701
1099
        # The reason for not killing a running checker is that if we
706
1104
        # checkers alone, the checker would have to take more time
707
1105
        # than 'timeout' for the client to be disabled, which is as it
708
1106
        # should be.
709
 
        
 
1107
 
710
1108
        if self.checker is not None and not self.checker.is_alive():
711
1109
            logger.warning("Checker was not alive; joining")
712
1110
            self.checker.join()
716
1114
            # Escape attributes for the shell
717
1115
            escaped_attrs = {
718
1116
                attr: re.escape(str(getattr(self, attr)))
719
 
                for attr in self.runtime_expansions }
 
1117
                for attr in self.runtime_expansions}
720
1118
            try:
721
1119
                command = self.checker_command % escaped_attrs
722
1120
            except TypeError as error:
734
1132
            # The exception is when not debugging but nevertheless
735
1133
            # running in the foreground; use the previously
736
1134
            # created wnull.
737
 
            popen_args = { "close_fds": True,
738
 
                           "shell": True,
739
 
                           "cwd": "/" }
 
1135
            popen_args = {"close_fds": True,
 
1136
                          "shell": True,
 
1137
                          "cwd": "/"}
740
1138
            if (not self.server_settings["debug"]
741
1139
                and self.server_settings["foreground"]):
742
1140
                popen_args.update({"stdout": wnull,
743
 
                                   "stderr": wnull })
744
 
            pipe = multiprocessing.Pipe(duplex = False)
 
1141
                                   "stderr": wnull})
 
1142
            pipe = multiprocessing.Pipe(duplex=False)
745
1143
            self.checker = multiprocessing.Process(
746
 
                target = call_pipe,
747
 
                args = (pipe[1], subprocess.call, command),
748
 
                kwargs = popen_args)
 
1144
                target=call_pipe,
 
1145
                args=(pipe[1], subprocess.call, command),
 
1146
                kwargs=popen_args)
749
1147
            self.checker.start()
750
 
            self.checker_callback_tag = gobject.io_add_watch(
751
 
                pipe[0].fileno(), gobject.IO_IN,
 
1148
            self.checker_callback_tag = GLib.io_add_watch(
 
1149
                pipe[0].fileno(), GLib.IO_IN,
752
1150
                self.checker_callback, pipe[0], command)
753
 
        # Re-run this periodically if run by gobject.timeout_add
 
1151
        # Re-run this periodically if run by GLib.timeout_add
754
1152
        return True
755
 
    
 
1153
 
756
1154
    def stop_checker(self):
757
1155
        """Force the checker process, if any, to stop."""
758
1156
        if self.checker_callback_tag:
759
 
            gobject.source_remove(self.checker_callback_tag)
 
1157
            GLib.source_remove(self.checker_callback_tag)
760
1158
            self.checker_callback_tag = None
761
1159
        if getattr(self, "checker", None) is None:
762
1160
            return
771
1169
                          byte_arrays=False):
772
1170
    """Decorators for marking methods of a DBusObjectWithProperties to
773
1171
    become properties on the D-Bus.
774
 
    
 
1172
 
775
1173
    The decorated method will be called with no arguments by "Get"
776
1174
    and with one argument by "Set".
777
 
    
 
1175
 
778
1176
    The parameters, where they are supported, are the same as
779
1177
    dbus.service.method, except there is only "signature", since the
780
1178
    type from Get() and the type sent to Set() is the same.
784
1182
    if byte_arrays and signature != "ay":
785
1183
        raise ValueError("Byte arrays not supported for non-'ay'"
786
1184
                         " signature {!r}".format(signature))
787
 
    
 
1185
 
788
1186
    def decorator(func):
789
1187
        func._dbus_is_property = True
790
1188
        func._dbus_interface = dbus_interface
793
1191
        func._dbus_name = func.__name__
794
1192
        if func._dbus_name.endswith("_dbus_property"):
795
1193
            func._dbus_name = func._dbus_name[:-14]
796
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
1194
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
797
1195
        return func
798
 
    
 
1196
 
799
1197
    return decorator
800
1198
 
801
1199
 
802
1200
def dbus_interface_annotations(dbus_interface):
803
1201
    """Decorator for marking functions returning interface annotations
804
 
    
 
1202
 
805
1203
    Usage:
806
 
    
 
1204
 
807
1205
    @dbus_interface_annotations("org.example.Interface")
808
1206
    def _foo(self):  # Function name does not matter
809
1207
        return {"org.freedesktop.DBus.Deprecated": "true",
810
1208
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
811
1209
                    "false"}
812
1210
    """
813
 
    
 
1211
 
814
1212
    def decorator(func):
815
1213
        func._dbus_is_interface = True
816
1214
        func._dbus_interface = dbus_interface
817
1215
        func._dbus_name = dbus_interface
818
1216
        return func
819
 
    
 
1217
 
820
1218
    return decorator
821
1219
 
822
1220
 
823
1221
def dbus_annotations(annotations):
824
1222
    """Decorator to annotate D-Bus methods, signals or properties
825
1223
    Usage:
826
 
    
 
1224
 
827
1225
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
828
1226
                       "org.freedesktop.DBus.Property."
829
1227
                       "EmitsChangedSignal": "false"})
831
1229
                           access="r")
832
1230
    def Property_dbus_property(self):
833
1231
        return dbus.Boolean(False)
 
1232
 
 
1233
    See also the DBusObjectWithAnnotations class.
834
1234
    """
835
 
    
 
1235
 
836
1236
    def decorator(func):
837
1237
        func._dbus_annotations = annotations
838
1238
        return func
839
 
    
 
1239
 
840
1240
    return decorator
841
1241
 
842
1242
 
858
1258
    pass
859
1259
 
860
1260
 
861
 
class DBusObjectWithProperties(dbus.service.Object):
862
 
    """A D-Bus object with properties.
863
 
    
864
 
    Classes inheriting from this can use the dbus_service_property
865
 
    decorator to expose methods as D-Bus properties.  It exposes the
866
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1261
class DBusObjectWithAnnotations(dbus.service.Object):
 
1262
    """A D-Bus object with annotations.
 
1263
 
 
1264
    Classes inheriting from this can use the dbus_annotations
 
1265
    decorator to add annotations to methods or signals.
867
1266
    """
868
 
    
 
1267
 
869
1268
    @staticmethod
870
1269
    def _is_dbus_thing(thing):
871
1270
        """Returns a function testing if an attribute is a D-Bus thing
872
 
        
 
1271
 
873
1272
        If called like _is_dbus_thing("method") it returns a function
874
1273
        suitable for use as predicate to inspect.getmembers().
875
1274
        """
876
1275
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
877
1276
                                   False)
878
 
    
 
1277
 
879
1278
    def _get_all_dbus_things(self, thing):
880
1279
        """Returns a generator of (name, attribute) pairs
881
1280
        """
884
1283
                for cls in self.__class__.__mro__
885
1284
                for name, athing in
886
1285
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
887
 
    
 
1286
 
 
1287
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1288
                         out_signature="s",
 
1289
                         path_keyword='object_path',
 
1290
                         connection_keyword='connection')
 
1291
    def Introspect(self, object_path, connection):
 
1292
        """Overloading of standard D-Bus method.
 
1293
 
 
1294
        Inserts annotation tags on methods and signals.
 
1295
        """
 
1296
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
1297
                                                   connection)
 
1298
        try:
 
1299
            document = xml.dom.minidom.parseString(xmlstring)
 
1300
 
 
1301
            for if_tag in document.getElementsByTagName("interface"):
 
1302
                # Add annotation tags
 
1303
                for typ in ("method", "signal"):
 
1304
                    for tag in if_tag.getElementsByTagName(typ):
 
1305
                        annots = dict()
 
1306
                        for name, prop in (self.
 
1307
                                           _get_all_dbus_things(typ)):
 
1308
                            if (name == tag.getAttribute("name")
 
1309
                                and prop._dbus_interface
 
1310
                                == if_tag.getAttribute("name")):
 
1311
                                annots.update(getattr(
 
1312
                                    prop, "_dbus_annotations", {}))
 
1313
                        for name, value in annots.items():
 
1314
                            ann_tag = document.createElement(
 
1315
                                "annotation")
 
1316
                            ann_tag.setAttribute("name", name)
 
1317
                            ann_tag.setAttribute("value", value)
 
1318
                            tag.appendChild(ann_tag)
 
1319
                # Add interface annotation tags
 
1320
                for annotation, value in dict(
 
1321
                    itertools.chain.from_iterable(
 
1322
                        annotations().items()
 
1323
                        for name, annotations
 
1324
                        in self._get_all_dbus_things("interface")
 
1325
                        if name == if_tag.getAttribute("name")
 
1326
                        )).items():
 
1327
                    ann_tag = document.createElement("annotation")
 
1328
                    ann_tag.setAttribute("name", annotation)
 
1329
                    ann_tag.setAttribute("value", value)
 
1330
                    if_tag.appendChild(ann_tag)
 
1331
                # Fix argument name for the Introspect method itself
 
1332
                if (if_tag.getAttribute("name")
 
1333
                    == dbus.INTROSPECTABLE_IFACE):
 
1334
                    for cn in if_tag.getElementsByTagName("method"):
 
1335
                        if cn.getAttribute("name") == "Introspect":
 
1336
                            for arg in cn.getElementsByTagName("arg"):
 
1337
                                if (arg.getAttribute("direction")
 
1338
                                    == "out"):
 
1339
                                    arg.setAttribute("name",
 
1340
                                                     "xml_data")
 
1341
            xmlstring = document.toxml("utf-8")
 
1342
            document.unlink()
 
1343
        except (AttributeError, xml.dom.DOMException,
 
1344
                xml.parsers.expat.ExpatError) as error:
 
1345
            logger.error("Failed to override Introspection method",
 
1346
                         exc_info=error)
 
1347
        return xmlstring
 
1348
 
 
1349
 
 
1350
class DBusObjectWithProperties(DBusObjectWithAnnotations):
 
1351
    """A D-Bus object with properties.
 
1352
 
 
1353
    Classes inheriting from this can use the dbus_service_property
 
1354
    decorator to expose methods as D-Bus properties.  It exposes the
 
1355
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1356
    """
 
1357
 
888
1358
    def _get_dbus_property(self, interface_name, property_name):
889
1359
        """Returns a bound method if one exists which is a D-Bus
890
1360
        property with the specified name and interface.
895
1365
                if (value._dbus_name == property_name
896
1366
                    and value._dbus_interface == interface_name):
897
1367
                    return value.__get__(self)
898
 
        
 
1368
 
899
1369
        # No such property
900
1370
        raise DBusPropertyNotFound("{}:{}.{}".format(
901
1371
            self.dbus_object_path, interface_name, property_name))
902
 
    
 
1372
 
 
1373
    @classmethod
 
1374
    def _get_all_interface_names(cls):
 
1375
        """Get a sequence of all interfaces supported by an object"""
 
1376
        return (name for name in set(getattr(getattr(x, attr),
 
1377
                                             "_dbus_interface", None)
 
1378
                                     for x in (inspect.getmro(cls))
 
1379
                                     for attr in dir(x))
 
1380
                if name is not None)
 
1381
 
903
1382
    @dbus.service.method(dbus.PROPERTIES_IFACE,
904
1383
                         in_signature="ss",
905
1384
                         out_signature="v")
913
1392
        if not hasattr(value, "variant_level"):
914
1393
            return value
915
1394
        return type(value)(value, variant_level=value.variant_level+1)
916
 
    
 
1395
 
917
1396
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
918
1397
    def Set(self, interface_name, property_name, value):
919
1398
        """Standard D-Bus property Set() method, see D-Bus standard.
931
1410
            value = dbus.ByteArray(b''.join(chr(byte)
932
1411
                                            for byte in value))
933
1412
        prop(value)
934
 
    
 
1413
 
935
1414
    @dbus.service.method(dbus.PROPERTIES_IFACE,
936
1415
                         in_signature="s",
937
1416
                         out_signature="a{sv}")
938
1417
    def GetAll(self, interface_name):
939
1418
        """Standard D-Bus property GetAll() method, see D-Bus
940
1419
        standard.
941
 
        
 
1420
 
942
1421
        Note: Will not include properties with access="write".
943
1422
        """
944
1423
        properties = {}
955
1434
                properties[name] = value
956
1435
                continue
957
1436
            properties[name] = type(value)(
958
 
                value, variant_level = value.variant_level + 1)
 
1437
                value, variant_level=value.variant_level + 1)
959
1438
        return dbus.Dictionary(properties, signature="sv")
960
 
    
 
1439
 
961
1440
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
962
1441
    def PropertiesChanged(self, interface_name, changed_properties,
963
1442
                          invalidated_properties):
965
1444
        standard.
966
1445
        """
967
1446
        pass
968
 
    
 
1447
 
969
1448
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
970
1449
                         out_signature="s",
971
1450
                         path_keyword='object_path',
972
1451
                         connection_keyword='connection')
973
1452
    def Introspect(self, object_path, connection):
974
1453
        """Overloading of standard D-Bus method.
975
 
        
 
1454
 
976
1455
        Inserts property tags and interface annotation tags.
977
1456
        """
978
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
979
 
                                                   connection)
 
1457
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1458
                                                         object_path,
 
1459
                                                         connection)
980
1460
        try:
981
1461
            document = xml.dom.minidom.parseString(xmlstring)
982
 
            
 
1462
 
983
1463
            def make_tag(document, name, prop):
984
1464
                e = document.createElement("property")
985
1465
                e.setAttribute("name", name)
986
1466
                e.setAttribute("type", prop._dbus_signature)
987
1467
                e.setAttribute("access", prop._dbus_access)
988
1468
                return e
989
 
            
 
1469
 
990
1470
            for if_tag in document.getElementsByTagName("interface"):
991
1471
                # Add property tags
992
1472
                for tag in (make_tag(document, name, prop)
995
1475
                            if prop._dbus_interface
996
1476
                            == if_tag.getAttribute("name")):
997
1477
                    if_tag.appendChild(tag)
998
 
                # Add annotation tags
999
 
                for typ in ("method", "signal", "property"):
1000
 
                    for tag in if_tag.getElementsByTagName(typ):
1001
 
                        annots = dict()
1002
 
                        for name, prop in (self.
1003
 
                                           _get_all_dbus_things(typ)):
1004
 
                            if (name == tag.getAttribute("name")
1005
 
                                and prop._dbus_interface
1006
 
                                == if_tag.getAttribute("name")):
1007
 
                                annots.update(getattr(
1008
 
                                    prop, "_dbus_annotations", {}))
1009
 
                        for name, value in annots.items():
1010
 
                            ann_tag = document.createElement(
1011
 
                                "annotation")
1012
 
                            ann_tag.setAttribute("name", name)
1013
 
                            ann_tag.setAttribute("value", value)
1014
 
                            tag.appendChild(ann_tag)
1015
 
                # Add interface annotation tags
1016
 
                for annotation, value in dict(
1017
 
                    itertools.chain.from_iterable(
1018
 
                        annotations().items()
1019
 
                        for name, annotations
1020
 
                        in self._get_all_dbus_things("interface")
1021
 
                        if name == if_tag.getAttribute("name")
1022
 
                        )).items():
1023
 
                    ann_tag = document.createElement("annotation")
1024
 
                    ann_tag.setAttribute("name", annotation)
1025
 
                    ann_tag.setAttribute("value", value)
1026
 
                    if_tag.appendChild(ann_tag)
 
1478
                # Add annotation tags for properties
 
1479
                for tag in if_tag.getElementsByTagName("property"):
 
1480
                    annots = dict()
 
1481
                    for name, prop in self._get_all_dbus_things(
 
1482
                            "property"):
 
1483
                        if (name == tag.getAttribute("name")
 
1484
                            and prop._dbus_interface
 
1485
                            == if_tag.getAttribute("name")):
 
1486
                            annots.update(getattr(
 
1487
                                prop, "_dbus_annotations", {}))
 
1488
                    for name, value in annots.items():
 
1489
                        ann_tag = document.createElement(
 
1490
                            "annotation")
 
1491
                        ann_tag.setAttribute("name", name)
 
1492
                        ann_tag.setAttribute("value", value)
 
1493
                        tag.appendChild(ann_tag)
1027
1494
                # Add the names to the return values for the
1028
1495
                # "org.freedesktop.DBus.Properties" methods
1029
1496
                if (if_tag.getAttribute("name")
1048
1515
        return xmlstring
1049
1516
 
1050
1517
 
 
1518
try:
 
1519
    dbus.OBJECT_MANAGER_IFACE
 
1520
except AttributeError:
 
1521
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
1522
 
 
1523
 
 
1524
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
1525
    """A D-Bus object with an ObjectManager.
 
1526
 
 
1527
    Classes inheriting from this exposes the standard
 
1528
    GetManagedObjects call and the InterfacesAdded and
 
1529
    InterfacesRemoved signals on the standard
 
1530
    "org.freedesktop.DBus.ObjectManager" interface.
 
1531
 
 
1532
    Note: No signals are sent automatically; they must be sent
 
1533
    manually.
 
1534
    """
 
1535
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
1536
                         out_signature="a{oa{sa{sv}}}")
 
1537
    def GetManagedObjects(self):
 
1538
        """This function must be overridden"""
 
1539
        raise NotImplementedError()
 
1540
 
 
1541
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
1542
                         signature="oa{sa{sv}}")
 
1543
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
1544
        pass
 
1545
 
 
1546
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
 
1547
    def InterfacesRemoved(self, object_path, interfaces):
 
1548
        pass
 
1549
 
 
1550
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1551
                         out_signature="s",
 
1552
                         path_keyword='object_path',
 
1553
                         connection_keyword='connection')
 
1554
    def Introspect(self, object_path, connection):
 
1555
        """Overloading of standard D-Bus method.
 
1556
 
 
1557
        Override return argument name of GetManagedObjects to be
 
1558
        "objpath_interfaces_and_properties"
 
1559
        """
 
1560
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1561
                                                         object_path,
 
1562
                                                         connection)
 
1563
        try:
 
1564
            document = xml.dom.minidom.parseString(xmlstring)
 
1565
 
 
1566
            for if_tag in document.getElementsByTagName("interface"):
 
1567
                # Fix argument name for the GetManagedObjects method
 
1568
                if (if_tag.getAttribute("name")
 
1569
                    == dbus.OBJECT_MANAGER_IFACE):
 
1570
                    for cn in if_tag.getElementsByTagName("method"):
 
1571
                        if (cn.getAttribute("name")
 
1572
                            == "GetManagedObjects"):
 
1573
                            for arg in cn.getElementsByTagName("arg"):
 
1574
                                if (arg.getAttribute("direction")
 
1575
                                    == "out"):
 
1576
                                    arg.setAttribute(
 
1577
                                        "name",
 
1578
                                        "objpath_interfaces"
 
1579
                                        "_and_properties")
 
1580
            xmlstring = document.toxml("utf-8")
 
1581
            document.unlink()
 
1582
        except (AttributeError, xml.dom.DOMException,
 
1583
                xml.parsers.expat.ExpatError) as error:
 
1584
            logger.error("Failed to override Introspection method",
 
1585
                         exc_info=error)
 
1586
        return xmlstring
 
1587
 
 
1588
 
1051
1589
def datetime_to_dbus(dt, variant_level=0):
1052
1590
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1053
1591
    if dt is None:
1054
 
        return dbus.String("", variant_level = variant_level)
 
1592
        return dbus.String("", variant_level=variant_level)
1055
1593
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1056
1594
 
1057
1595
 
1060
1598
    dbus.service.Object, it will add alternate D-Bus attributes with
1061
1599
    interface names according to the "alt_interface_names" mapping.
1062
1600
    Usage:
1063
 
    
 
1601
 
1064
1602
    @alternate_dbus_interfaces({"org.example.Interface":
1065
1603
                                    "net.example.AlternateInterface"})
1066
1604
    class SampleDBusObject(dbus.service.Object):
1067
1605
        @dbus.service.method("org.example.Interface")
1068
1606
        def SampleDBusMethod():
1069
1607
            pass
1070
 
    
 
1608
 
1071
1609
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1072
1610
    reachable via two interfaces: "org.example.Interface" and
1073
1611
    "net.example.AlternateInterface", the latter of which will have
1074
1612
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1075
1613
    "true", unless "deprecate" is passed with a False value.
1076
 
    
 
1614
 
1077
1615
    This works for methods and signals, and also for D-Bus properties
1078
1616
    (from DBusObjectWithProperties) and interfaces (from the
1079
1617
    dbus_interface_annotations decorator).
1080
1618
    """
1081
 
    
 
1619
 
1082
1620
    def wrapper(cls):
1083
1621
        for orig_interface_name, alt_interface_name in (
1084
1622
                alt_interface_names.items()):
1099
1637
                interface_names.add(alt_interface)
1100
1638
                # Is this a D-Bus signal?
1101
1639
                if getattr(attribute, "_dbus_is_signal", False):
 
1640
                    # Extract the original non-method undecorated
 
1641
                    # function by black magic
1102
1642
                    if sys.version_info.major == 2:
1103
 
                        # Extract the original non-method undecorated
1104
 
                        # function by black magic
1105
1643
                        nonmethod_func = (dict(
1106
1644
                            zip(attribute.func_code.co_freevars,
1107
1645
                                attribute.__closure__))
1108
1646
                                          ["func"].cell_contents)
1109
1647
                    else:
1110
 
                        nonmethod_func = attribute
 
1648
                        nonmethod_func = (dict(
 
1649
                            zip(attribute.__code__.co_freevars,
 
1650
                                attribute.__closure__))
 
1651
                                          ["func"].cell_contents)
1111
1652
                    # Create a new, but exactly alike, function
1112
1653
                    # object, and decorate it to be a new D-Bus signal
1113
1654
                    # with the alternate D-Bus interface name
1114
 
                    if sys.version_info.major == 2:
1115
 
                        new_function = types.FunctionType(
1116
 
                            nonmethod_func.func_code,
1117
 
                            nonmethod_func.func_globals,
1118
 
                            nonmethod_func.func_name,
1119
 
                            nonmethod_func.func_defaults,
1120
 
                            nonmethod_func.func_closure)
1121
 
                    else:
1122
 
                        new_function = types.FunctionType(
1123
 
                            nonmethod_func.__code__,
1124
 
                            nonmethod_func.__globals__,
1125
 
                            nonmethod_func.__name__,
1126
 
                            nonmethod_func.__defaults__,
1127
 
                            nonmethod_func.__closure__)
 
1655
                    new_function = copy_function(nonmethod_func)
1128
1656
                    new_function = (dbus.service.signal(
1129
1657
                        alt_interface,
1130
1658
                        attribute._dbus_signature)(new_function))
1134
1662
                            attribute._dbus_annotations)
1135
1663
                    except AttributeError:
1136
1664
                        pass
 
1665
 
1137
1666
                    # Define a creator of a function to call both the
1138
1667
                    # original and alternate functions, so both the
1139
1668
                    # original and alternate signals gets sent when
1142
1671
                        """This function is a scope container to pass
1143
1672
                        func1 and func2 to the "call_both" function
1144
1673
                        outside of its arguments"""
1145
 
                        
 
1674
 
 
1675
                        @functools.wraps(func2)
1146
1676
                        def call_both(*args, **kwargs):
1147
1677
                            """This function will emit two D-Bus
1148
1678
                            signals by calling func1 and func2"""
1149
1679
                            func1(*args, **kwargs)
1150
1680
                            func2(*args, **kwargs)
1151
 
                        
 
1681
                        # Make wrapper function look like a D-Bus
 
1682
                        # signal
 
1683
                        for name, attr in inspect.getmembers(func2):
 
1684
                            if name.startswith("_dbus_"):
 
1685
                                setattr(call_both, name, attr)
 
1686
 
1152
1687
                        return call_both
1153
1688
                    # Create the "call_both" function and add it to
1154
1689
                    # the class
1164
1699
                            alt_interface,
1165
1700
                            attribute._dbus_in_signature,
1166
1701
                            attribute._dbus_out_signature)
1167
 
                        (types.FunctionType(attribute.func_code,
1168
 
                                            attribute.func_globals,
1169
 
                                            attribute.func_name,
1170
 
                                            attribute.func_defaults,
1171
 
                                            attribute.func_closure)))
 
1702
                        (copy_function(attribute)))
1172
1703
                    # Copy annotations, if any
1173
1704
                    try:
1174
1705
                        attr[attrname]._dbus_annotations = dict(
1186
1717
                        attribute._dbus_access,
1187
1718
                        attribute._dbus_get_args_options
1188
1719
                        ["byte_arrays"])
1189
 
                                      (types.FunctionType(
1190
 
                                          attribute.func_code,
1191
 
                                          attribute.func_globals,
1192
 
                                          attribute.func_name,
1193
 
                                          attribute.func_defaults,
1194
 
                                          attribute.func_closure)))
 
1720
                                      (copy_function(attribute)))
1195
1721
                    # Copy annotations, if any
1196
1722
                    try:
1197
1723
                        attr[attrname]._dbus_annotations = dict(
1206
1732
                    # to the class.
1207
1733
                    attr[attrname] = (
1208
1734
                        dbus_interface_annotations(alt_interface)
1209
 
                        (types.FunctionType(attribute.func_code,
1210
 
                                            attribute.func_globals,
1211
 
                                            attribute.func_name,
1212
 
                                            attribute.func_defaults,
1213
 
                                            attribute.func_closure)))
 
1735
                        (copy_function(attribute)))
1214
1736
            if deprecate:
1215
1737
                # Deprecate all alternate interfaces
1216
 
                iname="_AlternateDBusNames_interface_annotation{}"
 
1738
                iname = "_AlternateDBusNames_interface_annotation{}"
1217
1739
                for interface_name in interface_names:
1218
 
                    
 
1740
 
1219
1741
                    @dbus_interface_annotations(interface_name)
1220
1742
                    def func(self):
1221
 
                        return { "org.freedesktop.DBus.Deprecated":
1222
 
                                 "true" }
 
1743
                        return {"org.freedesktop.DBus.Deprecated":
 
1744
                                "true"}
1223
1745
                    # Find an unused name
1224
1746
                    for aname in (iname.format(i)
1225
1747
                                  for i in itertools.count()):
1229
1751
            if interface_names:
1230
1752
                # Replace the class with a new subclass of it with
1231
1753
                # methods, signals, etc. as created above.
1232
 
                cls = type(b"{}Alternate".format(cls.__name__),
1233
 
                           (cls, ), attr)
 
1754
                if sys.version_info.major == 2:
 
1755
                    cls = type(b"{}Alternate".format(cls.__name__),
 
1756
                               (cls, ), attr)
 
1757
                else:
 
1758
                    cls = type("{}Alternate".format(cls.__name__),
 
1759
                               (cls, ), attr)
1234
1760
        return cls
1235
 
    
 
1761
 
1236
1762
    return wrapper
1237
1763
 
1238
1764
 
1240
1766
                            "se.bsnet.fukt.Mandos"})
1241
1767
class ClientDBus(Client, DBusObjectWithProperties):
1242
1768
    """A Client class using D-Bus
1243
 
    
 
1769
 
1244
1770
    Attributes:
1245
1771
    dbus_object_path: dbus.ObjectPath
1246
1772
    bus: dbus.SystemBus()
1247
1773
    """
1248
 
    
 
1774
 
1249
1775
    runtime_expansions = (Client.runtime_expansions
1250
1776
                          + ("dbus_object_path", ))
1251
 
    
 
1777
 
1252
1778
    _interface = "se.recompile.Mandos.Client"
1253
 
    
 
1779
 
1254
1780
    # dbus.service.Object doesn't use super(), so we can't either.
1255
 
    
1256
 
    def __init__(self, bus = None, *args, **kwargs):
 
1781
 
 
1782
    def __init__(self, bus=None, *args, **kwargs):
1257
1783
        self.bus = bus
1258
1784
        Client.__init__(self, *args, **kwargs)
1259
1785
        # Only now, when this client is initialized, can it show up on
1265
1791
            "/clients/" + client_object_name)
1266
1792
        DBusObjectWithProperties.__init__(self, self.bus,
1267
1793
                                          self.dbus_object_path)
1268
 
    
 
1794
 
1269
1795
    def notifychangeproperty(transform_func, dbus_name,
1270
1796
                             type_func=lambda x: x,
1271
1797
                             variant_level=1,
1273
1799
                             _interface=_interface):
1274
1800
        """ Modify a variable so that it's a property which announces
1275
1801
        its changes to DBus.
1276
 
        
 
1802
 
1277
1803
        transform_fun: Function that takes a value and a variant_level
1278
1804
                       and transforms it to a D-Bus type.
1279
1805
        dbus_name: D-Bus name of the variable
1282
1808
        variant_level: D-Bus variant level.  Default: 1
1283
1809
        """
1284
1810
        attrname = "_{}".format(dbus_name)
1285
 
        
 
1811
 
1286
1812
        def setter(self, value):
1287
1813
            if hasattr(self, "dbus_object_path"):
1288
1814
                if (not hasattr(self, attrname) or
1295
1821
                    else:
1296
1822
                        dbus_value = transform_func(
1297
1823
                            type_func(value),
1298
 
                            variant_level = variant_level)
 
1824
                            variant_level=variant_level)
1299
1825
                        self.PropertyChanged(dbus.String(dbus_name),
1300
1826
                                             dbus_value)
1301
1827
                        self.PropertiesChanged(
1302
1828
                            _interface,
1303
 
                            dbus.Dictionary({ dbus.String(dbus_name):
1304
 
                                              dbus_value }),
 
1829
                            dbus.Dictionary({dbus.String(dbus_name):
 
1830
                                             dbus_value}),
1305
1831
                            dbus.Array())
1306
1832
            setattr(self, attrname, value)
1307
 
        
 
1833
 
1308
1834
        return property(lambda self: getattr(self, attrname), setter)
1309
 
    
 
1835
 
1310
1836
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1311
1837
    approvals_pending = notifychangeproperty(dbus.Boolean,
1312
1838
                                             "ApprovalPending",
1313
 
                                             type_func = bool)
 
1839
                                             type_func=bool)
1314
1840
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1315
1841
    last_enabled = notifychangeproperty(datetime_to_dbus,
1316
1842
                                        "LastEnabled")
1317
1843
    checker = notifychangeproperty(
1318
1844
        dbus.Boolean, "CheckerRunning",
1319
 
        type_func = lambda checker: checker is not None)
 
1845
        type_func=lambda checker: checker is not None)
1320
1846
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1321
1847
                                           "LastCheckedOK")
1322
1848
    last_checker_status = notifychangeproperty(dbus.Int16,
1327
1853
                                               "ApprovedByDefault")
1328
1854
    approval_delay = notifychangeproperty(
1329
1855
        dbus.UInt64, "ApprovalDelay",
1330
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1856
        type_func=lambda td: td.total_seconds() * 1000)
1331
1857
    approval_duration = notifychangeproperty(
1332
1858
        dbus.UInt64, "ApprovalDuration",
1333
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1859
        type_func=lambda td: td.total_seconds() * 1000)
1334
1860
    host = notifychangeproperty(dbus.String, "Host")
1335
1861
    timeout = notifychangeproperty(
1336
1862
        dbus.UInt64, "Timeout",
1337
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1863
        type_func=lambda td: td.total_seconds() * 1000)
1338
1864
    extended_timeout = notifychangeproperty(
1339
1865
        dbus.UInt64, "ExtendedTimeout",
1340
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1866
        type_func=lambda td: td.total_seconds() * 1000)
1341
1867
    interval = notifychangeproperty(
1342
1868
        dbus.UInt64, "Interval",
1343
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1869
        type_func=lambda td: td.total_seconds() * 1000)
1344
1870
    checker_command = notifychangeproperty(dbus.String, "Checker")
1345
1871
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1346
1872
                                  invalidate_only=True)
1347
 
    
 
1873
 
1348
1874
    del notifychangeproperty
1349
 
    
 
1875
 
1350
1876
    def __del__(self, *args, **kwargs):
1351
1877
        try:
1352
1878
            self.remove_from_connection()
1355
1881
        if hasattr(DBusObjectWithProperties, "__del__"):
1356
1882
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1357
1883
        Client.__del__(self, *args, **kwargs)
1358
 
    
 
1884
 
1359
1885
    def checker_callback(self, source, condition,
1360
1886
                         connection, command, *args, **kwargs):
1361
1887
        ret = Client.checker_callback(self, source, condition,
1365
1891
        if exitstatus >= 0:
1366
1892
            # Emit D-Bus signal
1367
1893
            self.CheckerCompleted(dbus.Int16(exitstatus),
1368
 
                                  dbus.Int64(0),
 
1894
                                  # This is specific to GNU libC
 
1895
                                  dbus.Int64(exitstatus << 8),
1369
1896
                                  dbus.String(command))
1370
1897
        else:
1371
1898
            # Emit D-Bus signal
1372
1899
            self.CheckerCompleted(dbus.Int16(-1),
1373
1900
                                  dbus.Int64(
1374
 
                                      self.last_checker_signal),
 
1901
                                      # This is specific to GNU libC
 
1902
                                      (exitstatus << 8)
 
1903
                                      | self.last_checker_signal),
1375
1904
                                  dbus.String(command))
1376
1905
        return ret
1377
 
    
 
1906
 
1378
1907
    def start_checker(self, *args, **kwargs):
1379
1908
        old_checker_pid = getattr(self.checker, "pid", None)
1380
1909
        r = Client.start_checker(self, *args, **kwargs)
1384
1913
            # Emit D-Bus signal
1385
1914
            self.CheckerStarted(self.current_checker_command)
1386
1915
        return r
1387
 
    
 
1916
 
1388
1917
    def _reset_approved(self):
1389
1918
        self.approved = None
1390
1919
        return False
1391
 
    
 
1920
 
1392
1921
    def approve(self, value=True):
1393
1922
        self.approved = value
1394
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
1395
 
                                * 1000), self._reset_approved)
 
1923
        GLib.timeout_add(int(self.approval_duration.total_seconds()
 
1924
                             * 1000), self._reset_approved)
1396
1925
        self.send_changedstate()
1397
 
    
1398
 
    ## D-Bus methods, signals & properties
1399
 
    
1400
 
    ## Interfaces
1401
 
    
1402
 
    ## Signals
1403
 
    
 
1926
 
 
1927
    #  D-Bus methods, signals & properties
 
1928
 
 
1929
    #  Interfaces
 
1930
 
 
1931
    #  Signals
 
1932
 
1404
1933
    # CheckerCompleted - signal
1405
1934
    @dbus.service.signal(_interface, signature="nxs")
1406
1935
    def CheckerCompleted(self, exitcode, waitstatus, command):
1407
1936
        "D-Bus signal"
1408
1937
        pass
1409
 
    
 
1938
 
1410
1939
    # CheckerStarted - signal
1411
1940
    @dbus.service.signal(_interface, signature="s")
1412
1941
    def CheckerStarted(self, command):
1413
1942
        "D-Bus signal"
1414
1943
        pass
1415
 
    
 
1944
 
1416
1945
    # PropertyChanged - signal
1417
1946
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1418
1947
    @dbus.service.signal(_interface, signature="sv")
1419
1948
    def PropertyChanged(self, property, value):
1420
1949
        "D-Bus signal"
1421
1950
        pass
1422
 
    
 
1951
 
1423
1952
    # GotSecret - signal
1424
1953
    @dbus.service.signal(_interface)
1425
1954
    def GotSecret(self):
1428
1957
        server to mandos-client
1429
1958
        """
1430
1959
        pass
1431
 
    
 
1960
 
1432
1961
    # Rejected - signal
1433
1962
    @dbus.service.signal(_interface, signature="s")
1434
1963
    def Rejected(self, reason):
1435
1964
        "D-Bus signal"
1436
1965
        pass
1437
 
    
 
1966
 
1438
1967
    # NeedApproval - signal
1439
1968
    @dbus.service.signal(_interface, signature="tb")
1440
1969
    def NeedApproval(self, timeout, default):
1441
1970
        "D-Bus signal"
1442
1971
        return self.need_approval()
1443
 
    
1444
 
    ## Methods
1445
 
    
 
1972
 
 
1973
    #  Methods
 
1974
 
1446
1975
    # Approve - method
1447
1976
    @dbus.service.method(_interface, in_signature="b")
1448
1977
    def Approve(self, value):
1449
1978
        self.approve(value)
1450
 
    
 
1979
 
1451
1980
    # CheckedOK - method
1452
1981
    @dbus.service.method(_interface)
1453
1982
    def CheckedOK(self):
1454
1983
        self.checked_ok()
1455
 
    
 
1984
 
1456
1985
    # Enable - method
 
1986
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1457
1987
    @dbus.service.method(_interface)
1458
1988
    def Enable(self):
1459
1989
        "D-Bus method"
1460
1990
        self.enable()
1461
 
    
 
1991
 
1462
1992
    # StartChecker - method
 
1993
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1463
1994
    @dbus.service.method(_interface)
1464
1995
    def StartChecker(self):
1465
1996
        "D-Bus method"
1466
1997
        self.start_checker()
1467
 
    
 
1998
 
1468
1999
    # Disable - method
 
2000
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1469
2001
    @dbus.service.method(_interface)
1470
2002
    def Disable(self):
1471
2003
        "D-Bus method"
1472
2004
        self.disable()
1473
 
    
 
2005
 
1474
2006
    # StopChecker - method
 
2007
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1475
2008
    @dbus.service.method(_interface)
1476
2009
    def StopChecker(self):
1477
2010
        self.stop_checker()
1478
 
    
1479
 
    ## Properties
1480
 
    
 
2011
 
 
2012
    #  Properties
 
2013
 
1481
2014
    # ApprovalPending - property
1482
2015
    @dbus_service_property(_interface, signature="b", access="read")
1483
2016
    def ApprovalPending_dbus_property(self):
1484
2017
        return dbus.Boolean(bool(self.approvals_pending))
1485
 
    
 
2018
 
1486
2019
    # ApprovedByDefault - property
1487
2020
    @dbus_service_property(_interface,
1488
2021
                           signature="b",
1491
2024
        if value is None:       # get
1492
2025
            return dbus.Boolean(self.approved_by_default)
1493
2026
        self.approved_by_default = bool(value)
1494
 
    
 
2027
 
1495
2028
    # ApprovalDelay - property
1496
2029
    @dbus_service_property(_interface,
1497
2030
                           signature="t",
1501
2034
            return dbus.UInt64(self.approval_delay.total_seconds()
1502
2035
                               * 1000)
1503
2036
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1504
 
    
 
2037
 
1505
2038
    # ApprovalDuration - property
1506
2039
    @dbus_service_property(_interface,
1507
2040
                           signature="t",
1511
2044
            return dbus.UInt64(self.approval_duration.total_seconds()
1512
2045
                               * 1000)
1513
2046
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1514
 
    
 
2047
 
1515
2048
    # Name - property
 
2049
    @dbus_annotations(
 
2050
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1516
2051
    @dbus_service_property(_interface, signature="s", access="read")
1517
2052
    def Name_dbus_property(self):
1518
2053
        return dbus.String(self.name)
1519
 
    
 
2054
 
 
2055
    # KeyID - property
 
2056
    @dbus_annotations(
 
2057
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
2058
    @dbus_service_property(_interface, signature="s", access="read")
 
2059
    def KeyID_dbus_property(self):
 
2060
        return dbus.String(self.key_id)
 
2061
 
1520
2062
    # Fingerprint - property
 
2063
    @dbus_annotations(
 
2064
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1521
2065
    @dbus_service_property(_interface, signature="s", access="read")
1522
2066
    def Fingerprint_dbus_property(self):
1523
2067
        return dbus.String(self.fingerprint)
1524
 
    
 
2068
 
1525
2069
    # Host - property
1526
2070
    @dbus_service_property(_interface,
1527
2071
                           signature="s",
1530
2074
        if value is None:       # get
1531
2075
            return dbus.String(self.host)
1532
2076
        self.host = str(value)
1533
 
    
 
2077
 
1534
2078
    # Created - property
 
2079
    @dbus_annotations(
 
2080
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1535
2081
    @dbus_service_property(_interface, signature="s", access="read")
1536
2082
    def Created_dbus_property(self):
1537
2083
        return datetime_to_dbus(self.created)
1538
 
    
 
2084
 
1539
2085
    # LastEnabled - property
1540
2086
    @dbus_service_property(_interface, signature="s", access="read")
1541
2087
    def LastEnabled_dbus_property(self):
1542
2088
        return datetime_to_dbus(self.last_enabled)
1543
 
    
 
2089
 
1544
2090
    # Enabled - property
1545
2091
    @dbus_service_property(_interface,
1546
2092
                           signature="b",
1552
2098
            self.enable()
1553
2099
        else:
1554
2100
            self.disable()
1555
 
    
 
2101
 
1556
2102
    # LastCheckedOK - property
1557
2103
    @dbus_service_property(_interface,
1558
2104
                           signature="s",
1562
2108
            self.checked_ok()
1563
2109
            return
1564
2110
        return datetime_to_dbus(self.last_checked_ok)
1565
 
    
 
2111
 
1566
2112
    # LastCheckerStatus - property
1567
2113
    @dbus_service_property(_interface, signature="n", access="read")
1568
2114
    def LastCheckerStatus_dbus_property(self):
1569
2115
        return dbus.Int16(self.last_checker_status)
1570
 
    
 
2116
 
1571
2117
    # Expires - property
1572
2118
    @dbus_service_property(_interface, signature="s", access="read")
1573
2119
    def Expires_dbus_property(self):
1574
2120
        return datetime_to_dbus(self.expires)
1575
 
    
 
2121
 
1576
2122
    # LastApprovalRequest - property
1577
2123
    @dbus_service_property(_interface, signature="s", access="read")
1578
2124
    def LastApprovalRequest_dbus_property(self):
1579
2125
        return datetime_to_dbus(self.last_approval_request)
1580
 
    
 
2126
 
1581
2127
    # Timeout - property
1582
2128
    @dbus_service_property(_interface,
1583
2129
                           signature="t",
1598
2144
                if (getattr(self, "disable_initiator_tag", None)
1599
2145
                    is None):
1600
2146
                    return
1601
 
                gobject.source_remove(self.disable_initiator_tag)
1602
 
                self.disable_initiator_tag = gobject.timeout_add(
 
2147
                GLib.source_remove(self.disable_initiator_tag)
 
2148
                self.disable_initiator_tag = GLib.timeout_add(
1603
2149
                    int((self.expires - now).total_seconds() * 1000),
1604
2150
                    self.disable)
1605
 
    
 
2151
 
1606
2152
    # ExtendedTimeout - property
1607
2153
    @dbus_service_property(_interface,
1608
2154
                           signature="t",
1612
2158
            return dbus.UInt64(self.extended_timeout.total_seconds()
1613
2159
                               * 1000)
1614
2160
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1615
 
    
 
2161
 
1616
2162
    # Interval - property
1617
2163
    @dbus_service_property(_interface,
1618
2164
                           signature="t",
1625
2171
            return
1626
2172
        if self.enabled:
1627
2173
            # Reschedule checker run
1628
 
            gobject.source_remove(self.checker_initiator_tag)
1629
 
            self.checker_initiator_tag = gobject.timeout_add(
 
2174
            GLib.source_remove(self.checker_initiator_tag)
 
2175
            self.checker_initiator_tag = GLib.timeout_add(
1630
2176
                value, self.start_checker)
1631
 
            self.start_checker() # Start one now, too
1632
 
    
 
2177
            self.start_checker()  # Start one now, too
 
2178
 
1633
2179
    # Checker - property
1634
2180
    @dbus_service_property(_interface,
1635
2181
                           signature="s",
1638
2184
        if value is None:       # get
1639
2185
            return dbus.String(self.checker_command)
1640
2186
        self.checker_command = str(value)
1641
 
    
 
2187
 
1642
2188
    # CheckerRunning - property
1643
2189
    @dbus_service_property(_interface,
1644
2190
                           signature="b",
1650
2196
            self.start_checker()
1651
2197
        else:
1652
2198
            self.stop_checker()
1653
 
    
 
2199
 
1654
2200
    # ObjectPath - property
 
2201
    @dbus_annotations(
 
2202
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2203
         "org.freedesktop.DBus.Deprecated": "true"})
1655
2204
    @dbus_service_property(_interface, signature="o", access="read")
1656
2205
    def ObjectPath_dbus_property(self):
1657
 
        return self.dbus_object_path # is already a dbus.ObjectPath
1658
 
    
 
2206
        return self.dbus_object_path  # is already a dbus.ObjectPath
 
2207
 
1659
2208
    # Secret = property
 
2209
    @dbus_annotations(
 
2210
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2211
         "invalidates"})
1660
2212
    @dbus_service_property(_interface,
1661
2213
                           signature="ay",
1662
2214
                           access="write",
1663
2215
                           byte_arrays=True)
1664
2216
    def Secret_dbus_property(self, value):
1665
2217
        self.secret = bytes(value)
1666
 
    
 
2218
 
1667
2219
    del _interface
1668
2220
 
1669
2221
 
1670
2222
class ProxyClient(object):
1671
 
    def __init__(self, child_pipe, fpr, address):
 
2223
    def __init__(self, child_pipe, key_id, fpr, address):
1672
2224
        self._pipe = child_pipe
1673
 
        self._pipe.send(('init', fpr, address))
 
2225
        self._pipe.send(('init', key_id, fpr, address))
1674
2226
        if not self._pipe.recv():
1675
 
            raise KeyError(fpr)
1676
 
    
 
2227
            raise KeyError(key_id or fpr)
 
2228
 
1677
2229
    def __getattribute__(self, name):
1678
2230
        if name == '_pipe':
1679
2231
            return super(ProxyClient, self).__getattribute__(name)
1682
2234
        if data[0] == 'data':
1683
2235
            return data[1]
1684
2236
        if data[0] == 'function':
1685
 
            
 
2237
 
1686
2238
            def func(*args, **kwargs):
1687
2239
                self._pipe.send(('funcall', name, args, kwargs))
1688
2240
                return self._pipe.recv()[1]
1689
 
            
 
2241
 
1690
2242
            return func
1691
 
    
 
2243
 
1692
2244
    def __setattr__(self, name, value):
1693
2245
        if name == '_pipe':
1694
2246
            return super(ProxyClient, self).__setattr__(name, value)
1697
2249
 
1698
2250
class ClientHandler(socketserver.BaseRequestHandler, object):
1699
2251
    """A class to handle client connections.
1700
 
    
 
2252
 
1701
2253
    Instantiated once for each connection to handle it.
1702
2254
    Note: This will run in its own forked process."""
1703
 
    
 
2255
 
1704
2256
    def handle(self):
1705
2257
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1706
2258
            logger.info("TCP connection from: %s",
1707
2259
                        str(self.client_address))
1708
2260
            logger.debug("Pipe FD: %d",
1709
2261
                         self.server.child_pipe.fileno())
1710
 
            
1711
 
            session = gnutls.connection.ClientSession(
1712
 
                self.request, gnutls.connection .X509Credentials())
1713
 
            
1714
 
            # Note: gnutls.connection.X509Credentials is really a
1715
 
            # generic GnuTLS certificate credentials object so long as
1716
 
            # no X.509 keys are added to it.  Therefore, we can use it
1717
 
            # here despite using OpenPGP certificates.
1718
 
            
1719
 
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1720
 
            #                      "+AES-256-CBC", "+SHA1",
1721
 
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1722
 
            #                      "+DHE-DSS"))
 
2262
 
 
2263
            session = gnutls.ClientSession(self.request)
 
2264
 
 
2265
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
2266
            #                       "+AES-256-CBC", "+SHA1",
 
2267
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
 
2268
            #                       "+DHE-DSS"))
1723
2269
            # Use a fallback default, since this MUST be set.
1724
2270
            priority = self.server.gnutls_priority
1725
2271
            if priority is None:
1726
2272
                priority = "NORMAL"
1727
 
            gnutls.library.functions.gnutls_priority_set_direct(
1728
 
                session._c_object, priority, None)
1729
 
            
 
2273
            gnutls.priority_set_direct(session._c_object,
 
2274
                                       priority.encode("utf-8"),
 
2275
                                       None)
 
2276
 
1730
2277
            # Start communication using the Mandos protocol
1731
2278
            # Get protocol number
1732
2279
            line = self.request.makefile().readline()
1737
2284
            except (ValueError, IndexError, RuntimeError) as error:
1738
2285
                logger.error("Unknown protocol version: %s", error)
1739
2286
                return
1740
 
            
 
2287
 
1741
2288
            # Start GnuTLS connection
1742
2289
            try:
1743
2290
                session.handshake()
1744
 
            except gnutls.errors.GNUTLSError as error:
 
2291
            except gnutls.Error as error:
1745
2292
                logger.warning("Handshake failed: %s", error)
1746
2293
                # Do not run session.bye() here: the session is not
1747
2294
                # established.  Just abandon the request.
1748
2295
                return
1749
2296
            logger.debug("Handshake succeeded")
1750
 
            
 
2297
 
1751
2298
            approval_required = False
1752
2299
            try:
1753
 
                try:
1754
 
                    fpr = self.fingerprint(
1755
 
                        self.peer_certificate(session))
1756
 
                except (TypeError,
1757
 
                        gnutls.errors.GNUTLSError) as error:
1758
 
                    logger.warning("Bad certificate: %s", error)
1759
 
                    return
1760
 
                logger.debug("Fingerprint: %s", fpr)
1761
 
                
1762
 
                try:
1763
 
                    client = ProxyClient(child_pipe, fpr,
 
2300
                if gnutls.has_rawpk:
 
2301
                    fpr = ""
 
2302
                    try:
 
2303
                        key_id = self.key_id(
 
2304
                            self.peer_certificate(session))
 
2305
                    except (TypeError, gnutls.Error) as error:
 
2306
                        logger.warning("Bad certificate: %s", error)
 
2307
                        return
 
2308
                    logger.debug("Key ID: %s", key_id)
 
2309
 
 
2310
                else:
 
2311
                    key_id = ""
 
2312
                    try:
 
2313
                        fpr = self.fingerprint(
 
2314
                            self.peer_certificate(session))
 
2315
                    except (TypeError, gnutls.Error) as error:
 
2316
                        logger.warning("Bad certificate: %s", error)
 
2317
                        return
 
2318
                    logger.debug("Fingerprint: %s", fpr)
 
2319
 
 
2320
                try:
 
2321
                    client = ProxyClient(child_pipe, key_id, fpr,
1764
2322
                                         self.client_address)
1765
2323
                except KeyError:
1766
2324
                    return
1767
 
                
 
2325
 
1768
2326
                if client.approval_delay:
1769
2327
                    delay = client.approval_delay
1770
2328
                    client.approvals_pending += 1
1771
2329
                    approval_required = True
1772
 
                
 
2330
 
1773
2331
                while True:
1774
2332
                    if not client.enabled:
1775
2333
                        logger.info("Client %s is disabled",
1778
2336
                            # Emit D-Bus signal
1779
2337
                            client.Rejected("Disabled")
1780
2338
                        return
1781
 
                    
 
2339
 
1782
2340
                    if client.approved or not client.approval_delay:
1783
 
                        #We are approved or approval is disabled
 
2341
                        # We are approved or approval is disabled
1784
2342
                        break
1785
2343
                    elif client.approved is None:
1786
2344
                        logger.info("Client %s needs approval",
1797
2355
                            # Emit D-Bus signal
1798
2356
                            client.Rejected("Denied")
1799
2357
                        return
1800
 
                    
1801
 
                    #wait until timeout or approved
 
2358
 
 
2359
                    # wait until timeout or approved
1802
2360
                    time = datetime.datetime.now()
1803
2361
                    client.changedstate.acquire()
1804
2362
                    client.changedstate.wait(delay.total_seconds())
1817
2375
                            break
1818
2376
                    else:
1819
2377
                        delay -= time2 - time
1820
 
                
1821
 
                sent_size = 0
1822
 
                while sent_size < len(client.secret):
1823
 
                    try:
1824
 
                        sent = session.send(client.secret[sent_size:])
1825
 
                    except gnutls.errors.GNUTLSError as error:
1826
 
                        logger.warning("gnutls send failed",
1827
 
                                       exc_info=error)
1828
 
                        return
1829
 
                    logger.debug("Sent: %d, remaining: %d", sent,
1830
 
                                 len(client.secret) - (sent_size
1831
 
                                                       + sent))
1832
 
                    sent_size += sent
1833
 
                
 
2378
 
 
2379
                try:
 
2380
                    session.send(client.secret)
 
2381
                except gnutls.Error as error:
 
2382
                    logger.warning("gnutls send failed",
 
2383
                                   exc_info=error)
 
2384
                    return
 
2385
 
1834
2386
                logger.info("Sending secret to %s", client.name)
1835
2387
                # bump the timeout using extended_timeout
1836
2388
                client.bump_timeout(client.extended_timeout)
1837
2389
                if self.server.use_dbus:
1838
2390
                    # Emit D-Bus signal
1839
2391
                    client.GotSecret()
1840
 
            
 
2392
 
1841
2393
            finally:
1842
2394
                if approval_required:
1843
2395
                    client.approvals_pending -= 1
1844
2396
                try:
1845
2397
                    session.bye()
1846
 
                except gnutls.errors.GNUTLSError as error:
 
2398
                except gnutls.Error as error:
1847
2399
                    logger.warning("GnuTLS bye failed",
1848
2400
                                   exc_info=error)
1849
 
    
 
2401
 
1850
2402
    @staticmethod
1851
2403
    def peer_certificate(session):
1852
 
        "Return the peer's OpenPGP certificate as a bytestring"
1853
 
        # If not an OpenPGP certificate...
1854
 
        if (gnutls.library.functions.gnutls_certificate_type_get(
1855
 
                session._c_object)
1856
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1857
 
            # ...do the normal thing
1858
 
            return session.peer_certificate
 
2404
        "Return the peer's certificate as a bytestring"
 
2405
        try:
 
2406
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2407
                                                     gnutls.CTYPE_PEERS)
 
2408
        except AttributeError:
 
2409
            cert_type = gnutls.certificate_type_get(session._c_object)
 
2410
        if gnutls.has_rawpk:
 
2411
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
 
2412
        else:
 
2413
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
 
2414
        # If not a valid certificate type...
 
2415
        if cert_type not in valid_cert_types:
 
2416
            logger.info("Cert type %r not in %r", cert_type,
 
2417
                        valid_cert_types)
 
2418
            # ...return invalid data
 
2419
            return b""
1859
2420
        list_size = ctypes.c_uint(1)
1860
 
        cert_list = (gnutls.library.functions
1861
 
                     .gnutls_certificate_get_peers
 
2421
        cert_list = (gnutls.certificate_get_peers
1862
2422
                     (session._c_object, ctypes.byref(list_size)))
1863
2423
        if not bool(cert_list) and list_size.value != 0:
1864
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1865
 
                                            " certificate")
 
2424
            raise gnutls.Error("error getting peer certificate")
1866
2425
        if list_size.value == 0:
1867
2426
            return None
1868
2427
        cert = cert_list[0]
1869
2428
        return ctypes.string_at(cert.data, cert.size)
1870
 
    
 
2429
 
 
2430
    @staticmethod
 
2431
    def key_id(certificate):
 
2432
        "Convert a certificate bytestring to a hexdigit key ID"
 
2433
        # New GnuTLS "datum" with the public key
 
2434
        datum = gnutls.datum_t(
 
2435
            ctypes.cast(ctypes.c_char_p(certificate),
 
2436
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2437
            ctypes.c_uint(len(certificate)))
 
2438
        # XXX all these need to be created in the gnutls "module"
 
2439
        # New empty GnuTLS certificate
 
2440
        pubkey = gnutls.pubkey_t()
 
2441
        gnutls.pubkey_init(ctypes.byref(pubkey))
 
2442
        # Import the raw public key into the certificate
 
2443
        gnutls.pubkey_import(pubkey,
 
2444
                             ctypes.byref(datum),
 
2445
                             gnutls.X509_FMT_DER)
 
2446
        # New buffer for the key ID
 
2447
        buf = ctypes.create_string_buffer(32)
 
2448
        buf_len = ctypes.c_size_t(len(buf))
 
2449
        # Get the key ID from the raw public key into the buffer
 
2450
        gnutls.pubkey_get_key_id(pubkey,
 
2451
                                 gnutls.KEYID_USE_SHA256,
 
2452
                                 ctypes.cast(ctypes.byref(buf),
 
2453
                                             ctypes.POINTER(ctypes.c_ubyte)),
 
2454
                                 ctypes.byref(buf_len))
 
2455
        # Deinit the certificate
 
2456
        gnutls.pubkey_deinit(pubkey)
 
2457
 
 
2458
        # Convert the buffer to a Python bytestring
 
2459
        key_id = ctypes.string_at(buf, buf_len.value)
 
2460
        # Convert the bytestring to hexadecimal notation
 
2461
        hex_key_id = binascii.hexlify(key_id).upper()
 
2462
        return hex_key_id
 
2463
 
1871
2464
    @staticmethod
1872
2465
    def fingerprint(openpgp):
1873
2466
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1874
2467
        # New GnuTLS "datum" with the OpenPGP public key
1875
 
        datum = gnutls.library.types.gnutls_datum_t(
 
2468
        datum = gnutls.datum_t(
1876
2469
            ctypes.cast(ctypes.c_char_p(openpgp),
1877
2470
                        ctypes.POINTER(ctypes.c_ubyte)),
1878
2471
            ctypes.c_uint(len(openpgp)))
1879
2472
        # New empty GnuTLS certificate
1880
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1881
 
        gnutls.library.functions.gnutls_openpgp_crt_init(
1882
 
            ctypes.byref(crt))
 
2473
        crt = gnutls.openpgp_crt_t()
 
2474
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1883
2475
        # Import the OpenPGP public key into the certificate
1884
 
        gnutls.library.functions.gnutls_openpgp_crt_import(
1885
 
            crt, ctypes.byref(datum),
1886
 
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
2476
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2477
                                  gnutls.OPENPGP_FMT_RAW)
1887
2478
        # Verify the self signature in the key
1888
2479
        crtverify = ctypes.c_uint()
1889
 
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1890
 
            crt, 0, ctypes.byref(crtverify))
 
2480
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2481
                                       ctypes.byref(crtverify))
1891
2482
        if crtverify.value != 0:
1892
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1893
 
            raise gnutls.errors.CertificateSecurityError(
1894
 
                "Verify failed")
 
2483
            gnutls.openpgp_crt_deinit(crt)
 
2484
            raise gnutls.CertificateSecurityError(code
 
2485
                                                  =crtverify.value)
1895
2486
        # New buffer for the fingerprint
1896
2487
        buf = ctypes.create_string_buffer(20)
1897
2488
        buf_len = ctypes.c_size_t()
1898
2489
        # Get the fingerprint from the certificate into the buffer
1899
 
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1900
 
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
 
2490
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2491
                                           ctypes.byref(buf_len))
1901
2492
        # Deinit the certificate
1902
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2493
        gnutls.openpgp_crt_deinit(crt)
1903
2494
        # Convert the buffer to a Python bytestring
1904
2495
        fpr = ctypes.string_at(buf, buf_len.value)
1905
2496
        # Convert the bytestring to hexadecimal notation
1909
2500
 
1910
2501
class MultiprocessingMixIn(object):
1911
2502
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
1912
 
    
 
2503
 
1913
2504
    def sub_process_main(self, request, address):
1914
2505
        try:
1915
2506
            self.finish_request(request, address)
1916
2507
        except Exception:
1917
2508
            self.handle_error(request, address)
1918
2509
        self.close_request(request)
1919
 
    
 
2510
 
1920
2511
    def process_request(self, request, address):
1921
2512
        """Start a new process to process the request."""
1922
 
        proc = multiprocessing.Process(target = self.sub_process_main,
1923
 
                                       args = (request, address))
 
2513
        proc = multiprocessing.Process(target=self.sub_process_main,
 
2514
                                       args=(request, address))
1924
2515
        proc.start()
1925
2516
        return proc
1926
2517
 
1927
2518
 
1928
2519
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1929
2520
    """ adds a pipe to the MixIn """
1930
 
    
 
2521
 
1931
2522
    def process_request(self, request, client_address):
1932
2523
        """Overrides and wraps the original process_request().
1933
 
        
 
2524
 
1934
2525
        This function creates a new pipe in self.pipe
1935
2526
        """
1936
2527
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1937
 
        
 
2528
 
1938
2529
        proc = MultiprocessingMixIn.process_request(self, request,
1939
2530
                                                    client_address)
1940
2531
        self.child_pipe.close()
1941
2532
        self.add_pipe(parent_pipe, proc)
1942
 
    
 
2533
 
1943
2534
    def add_pipe(self, parent_pipe, proc):
1944
2535
        """Dummy function; override as necessary"""
1945
2536
        raise NotImplementedError()
1948
2539
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1949
2540
                     socketserver.TCPServer, object):
1950
2541
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1951
 
    
 
2542
 
1952
2543
    Attributes:
1953
2544
        enabled:        Boolean; whether this server is activated yet
1954
2545
        interface:      None or a network interface name (string)
1955
2546
        use_ipv6:       Boolean; to use IPv6 or not
1956
2547
    """
1957
 
    
 
2548
 
1958
2549
    def __init__(self, server_address, RequestHandlerClass,
1959
2550
                 interface=None,
1960
2551
                 use_ipv6=True,
1970
2561
            self.socketfd = socketfd
1971
2562
            # Save the original socket.socket() function
1972
2563
            self.socket_socket = socket.socket
 
2564
 
1973
2565
            # To implement --socket, we monkey patch socket.socket.
1974
 
            # 
 
2566
            #
1975
2567
            # (When socketserver.TCPServer is a new-style class, we
1976
2568
            # could make self.socket into a property instead of monkey
1977
2569
            # patching socket.socket.)
1978
 
            # 
 
2570
            #
1979
2571
            # Create a one-time-only replacement for socket.socket()
1980
2572
            @functools.wraps(socket.socket)
1981
2573
            def socket_wrapper(*args, **kwargs):
1993
2585
        # socket_wrapper(), if socketfd was set.
1994
2586
        socketserver.TCPServer.__init__(self, server_address,
1995
2587
                                        RequestHandlerClass)
1996
 
    
 
2588
 
1997
2589
    def server_bind(self):
1998
2590
        """This overrides the normal server_bind() function
1999
2591
        to bind to an interface if one was specified, and also NOT to
2000
2592
        bind to an address or port if they were not specified."""
 
2593
        global SO_BINDTODEVICE
2001
2594
        if self.interface is not None:
2002
2595
            if SO_BINDTODEVICE is None:
2003
 
                logger.error("SO_BINDTODEVICE does not exist;"
2004
 
                             " cannot bind to interface %s",
2005
 
                             self.interface)
2006
 
            else:
2007
 
                try:
2008
 
                    self.socket.setsockopt(
2009
 
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
2010
 
                        (self.interface + "\0").encode("utf-8"))
2011
 
                except socket.error as error:
2012
 
                    if error.errno == errno.EPERM:
2013
 
                        logger.error("No permission to bind to"
2014
 
                                     " interface %s", self.interface)
2015
 
                    elif error.errno == errno.ENOPROTOOPT:
2016
 
                        logger.error("SO_BINDTODEVICE not available;"
2017
 
                                     " cannot bind to interface %s",
2018
 
                                     self.interface)
2019
 
                    elif error.errno == errno.ENODEV:
2020
 
                        logger.error("Interface %s does not exist,"
2021
 
                                     " cannot bind", self.interface)
2022
 
                    else:
2023
 
                        raise
 
2596
                # Fall back to a hard-coded value which seems to be
 
2597
                # common enough.
 
2598
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2599
                SO_BINDTODEVICE = 25
 
2600
            try:
 
2601
                self.socket.setsockopt(
 
2602
                    socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2603
                    (self.interface + "\0").encode("utf-8"))
 
2604
            except socket.error as error:
 
2605
                if error.errno == errno.EPERM:
 
2606
                    logger.error("No permission to bind to"
 
2607
                                 " interface %s", self.interface)
 
2608
                elif error.errno == errno.ENOPROTOOPT:
 
2609
                    logger.error("SO_BINDTODEVICE not available;"
 
2610
                                 " cannot bind to interface %s",
 
2611
                                 self.interface)
 
2612
                elif error.errno == errno.ENODEV:
 
2613
                    logger.error("Interface %s does not exist,"
 
2614
                                 " cannot bind", self.interface)
 
2615
                else:
 
2616
                    raise
2024
2617
        # Only bind(2) the socket if we really need to.
2025
2618
        if self.server_address[0] or self.server_address[1]:
2026
2619
            if not self.server_address[0]:
2027
2620
                if self.address_family == socket.AF_INET6:
2028
 
                    any_address = "::" # in6addr_any
 
2621
                    any_address = "::"  # in6addr_any
2029
2622
                else:
2030
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
2623
                    any_address = "0.0.0.0"  # INADDR_ANY
2031
2624
                self.server_address = (any_address,
2032
2625
                                       self.server_address[1])
2033
2626
            elif not self.server_address[1]:
2043
2636
 
2044
2637
class MandosServer(IPv6_TCPServer):
2045
2638
    """Mandos server.
2046
 
    
 
2639
 
2047
2640
    Attributes:
2048
2641
        clients:        set of Client objects
2049
2642
        gnutls_priority GnuTLS priority string
2050
2643
        use_dbus:       Boolean; to emit D-Bus signals or not
2051
 
    
2052
 
    Assumes a gobject.MainLoop event loop.
 
2644
 
 
2645
    Assumes a GLib.MainLoop event loop.
2053
2646
    """
2054
 
    
 
2647
 
2055
2648
    def __init__(self, server_address, RequestHandlerClass,
2056
2649
                 interface=None,
2057
2650
                 use_ipv6=True,
2067
2660
        self.gnutls_priority = gnutls_priority
2068
2661
        IPv6_TCPServer.__init__(self, server_address,
2069
2662
                                RequestHandlerClass,
2070
 
                                interface = interface,
2071
 
                                use_ipv6 = use_ipv6,
2072
 
                                socketfd = socketfd)
2073
 
    
 
2663
                                interface=interface,
 
2664
                                use_ipv6=use_ipv6,
 
2665
                                socketfd=socketfd)
 
2666
 
2074
2667
    def server_activate(self):
2075
2668
        if self.enabled:
2076
2669
            return socketserver.TCPServer.server_activate(self)
2077
 
    
 
2670
 
2078
2671
    def enable(self):
2079
2672
        self.enabled = True
2080
 
    
 
2673
 
2081
2674
    def add_pipe(self, parent_pipe, proc):
2082
2675
        # Call "handle_ipc" for both data and EOF events
2083
 
        gobject.io_add_watch(
 
2676
        GLib.io_add_watch(
2084
2677
            parent_pipe.fileno(),
2085
 
            gobject.IO_IN | gobject.IO_HUP,
 
2678
            GLib.IO_IN | GLib.IO_HUP,
2086
2679
            functools.partial(self.handle_ipc,
2087
 
                              parent_pipe = parent_pipe,
2088
 
                              proc = proc))
2089
 
    
 
2680
                              parent_pipe=parent_pipe,
 
2681
                              proc=proc))
 
2682
 
2090
2683
    def handle_ipc(self, source, condition,
2091
2684
                   parent_pipe=None,
2092
 
                   proc = None,
 
2685
                   proc=None,
2093
2686
                   client_object=None):
2094
2687
        # error, or the other end of multiprocessing.Pipe has closed
2095
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2688
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
2096
2689
            # Wait for other process to exit
2097
2690
            proc.join()
2098
2691
            return False
2099
 
        
 
2692
 
2100
2693
        # Read a request from the child
2101
2694
        request = parent_pipe.recv()
2102
2695
        command = request[0]
2103
 
        
 
2696
 
2104
2697
        if command == 'init':
2105
 
            fpr = request[1]
2106
 
            address = request[2]
2107
 
            
2108
 
            for c in self.clients.itervalues():
2109
 
                if c.fingerprint == fpr:
 
2698
            key_id = request[1].decode("ascii")
 
2699
            fpr = request[2].decode("ascii")
 
2700
            address = request[3]
 
2701
 
 
2702
            for c in self.clients.values():
 
2703
                if key_id and c.key_id == key_id:
 
2704
                    client = c
 
2705
                    break
 
2706
                if fpr and c.fingerprint == fpr:
2110
2707
                    client = c
2111
2708
                    break
2112
2709
            else:
2113
 
                logger.info("Client not found for fingerprint: %s, ad"
2114
 
                            "dress: %s", fpr, address)
 
2710
                logger.info("Client not found for key ID: %s, address"
 
2711
                            ": %s", key_id or fpr, address)
2115
2712
                if self.use_dbus:
2116
2713
                    # Emit D-Bus signal
2117
 
                    mandos_dbus_service.ClientNotFound(fpr,
 
2714
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2118
2715
                                                       address[0])
2119
2716
                parent_pipe.send(False)
2120
2717
                return False
2121
 
            
2122
 
            gobject.io_add_watch(
 
2718
 
 
2719
            GLib.io_add_watch(
2123
2720
                parent_pipe.fileno(),
2124
 
                gobject.IO_IN | gobject.IO_HUP,
 
2721
                GLib.IO_IN | GLib.IO_HUP,
2125
2722
                functools.partial(self.handle_ipc,
2126
 
                                  parent_pipe = parent_pipe,
2127
 
                                  proc = proc,
2128
 
                                  client_object = client))
 
2723
                                  parent_pipe=parent_pipe,
 
2724
                                  proc=proc,
 
2725
                                  client_object=client))
2129
2726
            parent_pipe.send(True)
2130
2727
            # remove the old hook in favor of the new above hook on
2131
2728
            # same fileno
2134
2731
            funcname = request[1]
2135
2732
            args = request[2]
2136
2733
            kwargs = request[3]
2137
 
            
 
2734
 
2138
2735
            parent_pipe.send(('data', getattr(client_object,
2139
2736
                                              funcname)(*args,
2140
2737
                                                        **kwargs)))
2141
 
        
 
2738
 
2142
2739
        if command == 'getattr':
2143
2740
            attrname = request[1]
2144
2741
            if isinstance(client_object.__getattribute__(attrname),
2147
2744
            else:
2148
2745
                parent_pipe.send((
2149
2746
                    'data', client_object.__getattribute__(attrname)))
2150
 
        
 
2747
 
2151
2748
        if command == 'setattr':
2152
2749
            attrname = request[1]
2153
2750
            value = request[2]
2154
2751
            setattr(client_object, attrname, value)
2155
 
        
 
2752
 
2156
2753
        return True
2157
2754
 
2158
2755
 
2159
2756
def rfc3339_duration_to_delta(duration):
2160
2757
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2161
 
    
 
2758
 
2162
2759
    >>> rfc3339_duration_to_delta("P7D")
2163
2760
    datetime.timedelta(7)
2164
2761
    >>> rfc3339_duration_to_delta("PT60S")
2174
2771
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2175
2772
    datetime.timedelta(1, 200)
2176
2773
    """
2177
 
    
 
2774
 
2178
2775
    # Parsing an RFC 3339 duration with regular expressions is not
2179
2776
    # possible - there would have to be multiple places for the same
2180
2777
    # values, like seconds.  The current code, while more esoteric, is
2181
2778
    # cleaner without depending on a parsing library.  If Python had a
2182
2779
    # built-in library for parsing we would use it, but we'd like to
2183
2780
    # avoid excessive use of external libraries.
2184
 
    
 
2781
 
2185
2782
    # New type for defining tokens, syntax, and semantics all-in-one
2186
2783
    Token = collections.namedtuple("Token", (
2187
2784
        "regexp",  # To match token; if "value" is not None, must have
2220
2817
                           frozenset((token_year, token_month,
2221
2818
                                      token_day, token_time,
2222
2819
                                      token_week)))
2223
 
    # Define starting values
2224
 
    value = datetime.timedelta() # Value so far
 
2820
    # Define starting values:
 
2821
    # Value so far
 
2822
    value = datetime.timedelta()
2225
2823
    found_token = None
2226
 
    followers = frozenset((token_duration, )) # Following valid tokens
2227
 
    s = duration                # String left to parse
 
2824
    # Following valid tokens
 
2825
    followers = frozenset((token_duration, ))
 
2826
    # String left to parse
 
2827
    s = duration
2228
2828
    # Loop until end token is found
2229
2829
    while found_token is not token_end:
2230
2830
        # Search for any currently valid tokens
2254
2854
 
2255
2855
def string_to_delta(interval):
2256
2856
    """Parse a string and return a datetime.timedelta
2257
 
    
 
2857
 
2258
2858
    >>> string_to_delta('7d')
2259
2859
    datetime.timedelta(7)
2260
2860
    >>> string_to_delta('60s')
2268
2868
    >>> string_to_delta('5m 30s')
2269
2869
    datetime.timedelta(0, 330)
2270
2870
    """
2271
 
    
 
2871
 
2272
2872
    try:
2273
2873
        return rfc3339_duration_to_delta(interval)
2274
2874
    except ValueError:
2275
2875
        pass
2276
 
    
 
2876
 
2277
2877
    timevalue = datetime.timedelta(0)
2278
2878
    for s in interval.split():
2279
2879
        try:
2297
2897
    return timevalue
2298
2898
 
2299
2899
 
2300
 
def daemon(nochdir = False, noclose = False):
 
2900
def daemon(nochdir=False, noclose=False):
2301
2901
    """See daemon(3).  Standard BSD Unix function.
2302
 
    
 
2902
 
2303
2903
    This should really exist as os.daemon, but it doesn't (yet)."""
2304
2904
    if os.fork():
2305
2905
        sys.exit()
2323
2923
 
2324
2924
 
2325
2925
def main():
2326
 
    
 
2926
 
2327
2927
    ##################################################################
2328
2928
    # Parsing of options, both command line and config file
2329
 
    
 
2929
 
2330
2930
    parser = argparse.ArgumentParser()
2331
2931
    parser.add_argument("-v", "--version", action="version",
2332
 
                        version = "%(prog)s {}".format(version),
 
2932
                        version="%(prog)s {}".format(version),
2333
2933
                        help="show version number and exit")
2334
2934
    parser.add_argument("-i", "--interface", metavar="IF",
2335
2935
                        help="Bind to interface IF")
2371
2971
    parser.add_argument("--no-zeroconf", action="store_false",
2372
2972
                        dest="zeroconf", help="Do not use Zeroconf",
2373
2973
                        default=None)
2374
 
    
 
2974
 
2375
2975
    options = parser.parse_args()
2376
 
    
 
2976
 
2377
2977
    if options.check:
2378
2978
        import doctest
2379
2979
        fail_count, test_count = doctest.testmod()
2380
2980
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2381
 
    
 
2981
 
2382
2982
    # Default values for config file for server-global settings
2383
 
    server_defaults = { "interface": "",
2384
 
                        "address": "",
2385
 
                        "port": "",
2386
 
                        "debug": "False",
2387
 
                        "priority":
2388
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2389
 
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2390
 
                        "servicename": "Mandos",
2391
 
                        "use_dbus": "True",
2392
 
                        "use_ipv6": "True",
2393
 
                        "debuglevel": "",
2394
 
                        "restore": "True",
2395
 
                        "socket": "",
2396
 
                        "statedir": "/var/lib/mandos",
2397
 
                        "foreground": "False",
2398
 
                        "zeroconf": "True",
2399
 
                    }
2400
 
    
 
2983
    if gnutls.has_rawpk:
 
2984
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
 
2985
                    ":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
 
2986
    else:
 
2987
        priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2988
                    ":+SIGN-DSA-SHA256")
 
2989
    server_defaults = {"interface": "",
 
2990
                       "address": "",
 
2991
                       "port": "",
 
2992
                       "debug": "False",
 
2993
                       "priority": priority,
 
2994
                       "servicename": "Mandos",
 
2995
                       "use_dbus": "True",
 
2996
                       "use_ipv6": "True",
 
2997
                       "debuglevel": "",
 
2998
                       "restore": "True",
 
2999
                       "socket": "",
 
3000
                       "statedir": "/var/lib/mandos",
 
3001
                       "foreground": "False",
 
3002
                       "zeroconf": "True",
 
3003
                       }
 
3004
    del priority
 
3005
 
2401
3006
    # Parse config file for server-global settings
2402
3007
    server_config = configparser.SafeConfigParser(server_defaults)
2403
3008
    del server_defaults
2405
3010
    # Convert the SafeConfigParser object to a dict
2406
3011
    server_settings = server_config.defaults()
2407
3012
    # Use the appropriate methods on the non-string config options
2408
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
3013
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
3014
                   "foreground", "zeroconf"):
2409
3015
        server_settings[option] = server_config.getboolean("DEFAULT",
2410
3016
                                                           option)
2411
3017
    if server_settings["port"]:
2421
3027
            server_settings["socket"] = os.dup(server_settings
2422
3028
                                               ["socket"])
2423
3029
    del server_config
2424
 
    
 
3030
 
2425
3031
    # Override the settings from the config file with command line
2426
3032
    # options, if set.
2427
3033
    for option in ("interface", "address", "port", "debug",
2445
3051
    if server_settings["debug"]:
2446
3052
        server_settings["foreground"] = True
2447
3053
    # Now we have our good server settings in "server_settings"
2448
 
    
 
3054
 
2449
3055
    ##################################################################
2450
 
    
 
3056
 
2451
3057
    if (not server_settings["zeroconf"]
2452
3058
        and not (server_settings["port"]
2453
3059
                 or server_settings["socket"] != "")):
2454
3060
        parser.error("Needs port or socket to work without Zeroconf")
2455
 
    
 
3061
 
2456
3062
    # For convenience
2457
3063
    debug = server_settings["debug"]
2458
3064
    debuglevel = server_settings["debuglevel"]
2462
3068
                                     stored_state_file)
2463
3069
    foreground = server_settings["foreground"]
2464
3070
    zeroconf = server_settings["zeroconf"]
2465
 
    
 
3071
 
2466
3072
    if debug:
2467
3073
        initlogger(debug, logging.DEBUG)
2468
3074
    else:
2471
3077
        else:
2472
3078
            level = getattr(logging, debuglevel.upper())
2473
3079
            initlogger(debug, level)
2474
 
    
 
3080
 
2475
3081
    if server_settings["servicename"] != "Mandos":
2476
3082
        syslogger.setFormatter(
2477
3083
            logging.Formatter('Mandos ({}) [%(process)d]:'
2478
3084
                              ' %(levelname)s: %(message)s'.format(
2479
3085
                                  server_settings["servicename"])))
2480
 
    
 
3086
 
2481
3087
    # Parse config file with clients
2482
3088
    client_config = configparser.SafeConfigParser(Client
2483
3089
                                                  .client_defaults)
2484
3090
    client_config.read(os.path.join(server_settings["configdir"],
2485
3091
                                    "clients.conf"))
2486
 
    
 
3092
 
2487
3093
    global mandos_dbus_service
2488
3094
    mandos_dbus_service = None
2489
 
    
 
3095
 
2490
3096
    socketfd = None
2491
3097
    if server_settings["socket"] != "":
2492
3098
        socketfd = server_settings["socket"]
2508
3114
        except IOError as e:
2509
3115
            logger.error("Could not open file %r", pidfilename,
2510
3116
                         exc_info=e)
2511
 
    
2512
 
    for name in ("_mandos", "mandos", "nobody"):
 
3117
 
 
3118
    for name, group in (("_mandos", "_mandos"),
 
3119
                        ("mandos", "mandos"),
 
3120
                        ("nobody", "nogroup")):
2513
3121
        try:
2514
3122
            uid = pwd.getpwnam(name).pw_uid
2515
 
            gid = pwd.getpwnam(name).pw_gid
 
3123
            gid = pwd.getpwnam(group).pw_gid
2516
3124
            break
2517
3125
        except KeyError:
2518
3126
            continue
2522
3130
    try:
2523
3131
        os.setgid(gid)
2524
3132
        os.setuid(uid)
 
3133
        if debug:
 
3134
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3135
                                                             gid))
2525
3136
    except OSError as error:
 
3137
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3138
                       .format(uid, gid, os.strerror(error.errno)))
2526
3139
        if error.errno != errno.EPERM:
2527
3140
            raise
2528
 
    
 
3141
 
2529
3142
    if debug:
2530
3143
        # Enable all possible GnuTLS debugging
2531
 
        
 
3144
 
2532
3145
        # "Use a log level over 10 to enable all debugging options."
2533
3146
        # - GnuTLS manual
2534
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
2535
 
        
2536
 
        @gnutls.library.types.gnutls_log_func
 
3147
        gnutls.global_set_log_level(11)
 
3148
 
 
3149
        @gnutls.log_func
2537
3150
        def debug_gnutls(level, string):
2538
3151
            logger.debug("GnuTLS: %s", string[:-1])
2539
 
        
2540
 
        gnutls.library.functions.gnutls_global_set_log_function(
2541
 
            debug_gnutls)
2542
 
        
 
3152
 
 
3153
        gnutls.global_set_log_function(debug_gnutls)
 
3154
 
2543
3155
        # Redirect stdin so all checkers get /dev/null
2544
3156
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2545
3157
        os.dup2(null, sys.stdin.fileno())
2546
3158
        if null > 2:
2547
3159
            os.close(null)
2548
 
    
 
3160
 
2549
3161
    # Need to fork before connecting to D-Bus
2550
3162
    if not foreground:
2551
3163
        # Close all input and output, do double fork, etc.
2552
3164
        daemon()
2553
 
    
2554
 
    # multiprocessing will use threads, so before we use gobject we
2555
 
    # need to inform gobject that threads will be used.
2556
 
    gobject.threads_init()
2557
 
    
 
3165
 
 
3166
    # multiprocessing will use threads, so before we use GLib we need
 
3167
    # to inform GLib that threads will be used.
 
3168
    GLib.threads_init()
 
3169
 
2558
3170
    global main_loop
2559
3171
    # From the Avahi example code
2560
3172
    DBusGMainLoop(set_as_default=True)
2561
 
    main_loop = gobject.MainLoop()
 
3173
    main_loop = GLib.MainLoop()
2562
3174
    bus = dbus.SystemBus()
2563
3175
    # End of Avahi example code
2564
3176
    if use_dbus:
2577
3189
    if zeroconf:
2578
3190
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2579
3191
        service = AvahiServiceToSyslog(
2580
 
            name = server_settings["servicename"],
2581
 
            servicetype = "_mandos._tcp",
2582
 
            protocol = protocol,
2583
 
            bus = bus)
 
3192
            name=server_settings["servicename"],
 
3193
            servicetype="_mandos._tcp",
 
3194
            protocol=protocol,
 
3195
            bus=bus)
2584
3196
        if server_settings["interface"]:
2585
3197
            service.interface = if_nametoindex(
2586
3198
                server_settings["interface"].encode("utf-8"))
2587
 
    
 
3199
 
2588
3200
    global multiprocessing_manager
2589
3201
    multiprocessing_manager = multiprocessing.Manager()
2590
 
    
 
3202
 
2591
3203
    client_class = Client
2592
3204
    if use_dbus:
2593
 
        client_class = functools.partial(ClientDBus, bus = bus)
2594
 
    
 
3205
        client_class = functools.partial(ClientDBus, bus=bus)
 
3206
 
2595
3207
    client_settings = Client.config_parser(client_config)
2596
3208
    old_client_settings = {}
2597
3209
    clients_data = {}
2598
 
    
 
3210
 
2599
3211
    # This is used to redirect stdout and stderr for checker processes
2600
3212
    global wnull
2601
 
    wnull = open(os.devnull, "w") # A writable /dev/null
 
3213
    wnull = open(os.devnull, "w")  # A writable /dev/null
2602
3214
    # Only used if server is running in foreground but not in debug
2603
3215
    # mode
2604
3216
    if debug or not foreground:
2605
3217
        wnull.close()
2606
 
    
 
3218
 
2607
3219
    # Get client data and settings from last running state.
2608
3220
    if server_settings["restore"]:
2609
3221
        try:
2610
3222
            with open(stored_state_path, "rb") as stored_state:
2611
 
                clients_data, old_client_settings = pickle.load(
2612
 
                    stored_state)
 
3223
                if sys.version_info.major == 2:
 
3224
                    clients_data, old_client_settings = pickle.load(
 
3225
                        stored_state)
 
3226
                else:
 
3227
                    bytes_clients_data, bytes_old_client_settings = (
 
3228
                        pickle.load(stored_state, encoding="bytes"))
 
3229
                    #   Fix bytes to strings
 
3230
                    #  clients_data
 
3231
                    # .keys()
 
3232
                    clients_data = {(key.decode("utf-8")
 
3233
                                     if isinstance(key, bytes)
 
3234
                                     else key): value
 
3235
                                    for key, value in
 
3236
                                    bytes_clients_data.items()}
 
3237
                    del bytes_clients_data
 
3238
                    for key in clients_data:
 
3239
                        value = {(k.decode("utf-8")
 
3240
                                  if isinstance(k, bytes) else k): v
 
3241
                                 for k, v in
 
3242
                                 clients_data[key].items()}
 
3243
                        clients_data[key] = value
 
3244
                        # .client_structure
 
3245
                        value["client_structure"] = [
 
3246
                            (s.decode("utf-8")
 
3247
                             if isinstance(s, bytes)
 
3248
                             else s) for s in
 
3249
                            value["client_structure"]]
 
3250
                        # .name & .host
 
3251
                        for k in ("name", "host"):
 
3252
                            if isinstance(value[k], bytes):
 
3253
                                value[k] = value[k].decode("utf-8")
 
3254
                        if not value.has_key("key_id"):
 
3255
                            value["key_id"] = ""
 
3256
                        elif not value.has_key("fingerprint"):
 
3257
                            value["fingerprint"] = ""
 
3258
                    #  old_client_settings
 
3259
                    # .keys()
 
3260
                    old_client_settings = {
 
3261
                        (key.decode("utf-8")
 
3262
                         if isinstance(key, bytes)
 
3263
                         else key): value
 
3264
                        for key, value in
 
3265
                        bytes_old_client_settings.items()}
 
3266
                    del bytes_old_client_settings
 
3267
                    # .host
 
3268
                    for value in old_client_settings.values():
 
3269
                        if isinstance(value["host"], bytes):
 
3270
                            value["host"] = (value["host"]
 
3271
                                             .decode("utf-8"))
2613
3272
            os.remove(stored_state_path)
2614
3273
        except IOError as e:
2615
3274
            if e.errno == errno.ENOENT:
2623
3282
            logger.warning("Could not load persistent state: "
2624
3283
                           "EOFError:",
2625
3284
                           exc_info=e)
2626
 
    
 
3285
 
2627
3286
    with PGPEngine() as pgp:
2628
3287
        for client_name, client in clients_data.items():
2629
3288
            # Skip removed clients
2630
3289
            if client_name not in client_settings:
2631
3290
                continue
2632
 
            
 
3291
 
2633
3292
            # Decide which value to use after restoring saved state.
2634
3293
            # We have three different values: Old config file,
2635
3294
            # new config file, and saved state.
2646
3305
                        client[name] = value
2647
3306
                except KeyError:
2648
3307
                    pass
2649
 
            
 
3308
 
2650
3309
            # Clients who has passed its expire date can still be
2651
3310
            # enabled if its last checker was successful.  A Client
2652
3311
            # whose checker succeeded before we stored its state is
2685
3344
                    client_name))
2686
3345
                client["secret"] = (client_settings[client_name]
2687
3346
                                    ["secret"])
2688
 
    
 
3347
 
2689
3348
    # Add/remove clients based on new changes made to config
2690
3349
    for client_name in (set(old_client_settings)
2691
3350
                        - set(client_settings)):
2693
3352
    for client_name in (set(client_settings)
2694
3353
                        - set(old_client_settings)):
2695
3354
        clients_data[client_name] = client_settings[client_name]
2696
 
    
 
3355
 
2697
3356
    # Create all client objects
2698
3357
    for client_name, client in clients_data.items():
2699
3358
        tcp_server.clients[client_name] = client_class(
2700
 
            name = client_name,
2701
 
            settings = client,
2702
 
            server_settings = server_settings)
2703
 
    
 
3359
            name=client_name,
 
3360
            settings=client,
 
3361
            server_settings=server_settings)
 
3362
 
2704
3363
    if not tcp_server.clients:
2705
3364
        logger.warning("No clients defined")
2706
 
    
 
3365
 
2707
3366
    if not foreground:
2708
3367
        if pidfile is not None:
2709
3368
            pid = os.getpid()
2715
3374
                             pidfilename, pid)
2716
3375
        del pidfile
2717
3376
        del pidfilename
2718
 
    
2719
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2720
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2721
 
    
 
3377
 
 
3378
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
3379
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
3380
                             lambda: main_loop.quit() and False)
 
3381
 
2722
3382
    if use_dbus:
2723
 
        
 
3383
 
2724
3384
        @alternate_dbus_interfaces(
2725
 
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2726
 
        class MandosDBusService(DBusObjectWithProperties):
 
3385
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
 
3386
        class MandosDBusService(DBusObjectWithObjectManager):
2727
3387
            """A D-Bus proxy object"""
2728
 
            
 
3388
 
2729
3389
            def __init__(self):
2730
3390
                dbus.service.Object.__init__(self, bus, "/")
2731
 
            
 
3391
 
2732
3392
            _interface = "se.recompile.Mandos"
2733
 
            
2734
 
            @dbus_interface_annotations(_interface)
2735
 
            def _foo(self):
2736
 
                return {
2737
 
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
2738
 
                    "false" }
2739
 
            
 
3393
 
2740
3394
            @dbus.service.signal(_interface, signature="o")
2741
3395
            def ClientAdded(self, objpath):
2742
3396
                "D-Bus signal"
2743
3397
                pass
2744
 
            
 
3398
 
2745
3399
            @dbus.service.signal(_interface, signature="ss")
2746
 
            def ClientNotFound(self, fingerprint, address):
 
3400
            def ClientNotFound(self, key_id, address):
2747
3401
                "D-Bus signal"
2748
3402
                pass
2749
 
            
 
3403
 
 
3404
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3405
                               "true"})
2750
3406
            @dbus.service.signal(_interface, signature="os")
2751
3407
            def ClientRemoved(self, objpath, name):
2752
3408
                "D-Bus signal"
2753
3409
                pass
2754
 
            
 
3410
 
 
3411
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3412
                               "true"})
2755
3413
            @dbus.service.method(_interface, out_signature="ao")
2756
3414
            def GetAllClients(self):
2757
3415
                "D-Bus method"
2758
3416
                return dbus.Array(c.dbus_object_path for c in
2759
 
                                  tcp_server.clients.itervalues())
2760
 
            
 
3417
                                  tcp_server.clients.values())
 
3418
 
 
3419
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3420
                               "true"})
2761
3421
            @dbus.service.method(_interface,
2762
3422
                                 out_signature="a{oa{sv}}")
2763
3423
            def GetAllClientsWithProperties(self):
2764
3424
                "D-Bus method"
2765
3425
                return dbus.Dictionary(
2766
 
                    { c.dbus_object_path: c.GetAll("")
2767
 
                      for c in tcp_server.clients.itervalues() },
 
3426
                    {c.dbus_object_path: c.GetAll(
 
3427
                        "se.recompile.Mandos.Client")
 
3428
                     for c in tcp_server.clients.values()},
2768
3429
                    signature="oa{sv}")
2769
 
            
 
3430
 
2770
3431
            @dbus.service.method(_interface, in_signature="o")
2771
3432
            def RemoveClient(self, object_path):
2772
3433
                "D-Bus method"
2773
 
                for c in tcp_server.clients.itervalues():
 
3434
                for c in tcp_server.clients.values():
2774
3435
                    if c.dbus_object_path == object_path:
2775
3436
                        del tcp_server.clients[c.name]
2776
3437
                        c.remove_from_connection()
2777
 
                        # Don't signal anything except ClientRemoved
 
3438
                        # Don't signal the disabling
2778
3439
                        c.disable(quiet=True)
2779
 
                        # Emit D-Bus signal
2780
 
                        self.ClientRemoved(object_path, c.name)
 
3440
                        # Emit D-Bus signal for removal
 
3441
                        self.client_removed_signal(c)
2781
3442
                        return
2782
3443
                raise KeyError(object_path)
2783
 
            
 
3444
 
2784
3445
            del _interface
2785
 
        
 
3446
 
 
3447
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
3448
                                 out_signature="a{oa{sa{sv}}}")
 
3449
            def GetManagedObjects(self):
 
3450
                """D-Bus method"""
 
3451
                return dbus.Dictionary(
 
3452
                    {client.dbus_object_path:
 
3453
                     dbus.Dictionary(
 
3454
                         {interface: client.GetAll(interface)
 
3455
                          for interface in
 
3456
                          client._get_all_interface_names()})
 
3457
                     for client in tcp_server.clients.values()})
 
3458
 
 
3459
            def client_added_signal(self, client):
 
3460
                """Send the new standard signal and the old signal"""
 
3461
                if use_dbus:
 
3462
                    # New standard signal
 
3463
                    self.InterfacesAdded(
 
3464
                        client.dbus_object_path,
 
3465
                        dbus.Dictionary(
 
3466
                            {interface: client.GetAll(interface)
 
3467
                             for interface in
 
3468
                             client._get_all_interface_names()}))
 
3469
                    # Old signal
 
3470
                    self.ClientAdded(client.dbus_object_path)
 
3471
 
 
3472
            def client_removed_signal(self, client):
 
3473
                """Send the new standard signal and the old signal"""
 
3474
                if use_dbus:
 
3475
                    # New standard signal
 
3476
                    self.InterfacesRemoved(
 
3477
                        client.dbus_object_path,
 
3478
                        client._get_all_interface_names())
 
3479
                    # Old signal
 
3480
                    self.ClientRemoved(client.dbus_object_path,
 
3481
                                       client.name)
 
3482
 
2786
3483
        mandos_dbus_service = MandosDBusService()
2787
 
    
 
3484
 
 
3485
    # Save modules to variables to exempt the modules from being
 
3486
    # unloaded before the function registered with atexit() is run.
 
3487
    mp = multiprocessing
 
3488
    wn = wnull
 
3489
 
2788
3490
    def cleanup():
2789
3491
        "Cleanup function; run on exit"
2790
3492
        if zeroconf:
2791
3493
            service.cleanup()
2792
 
        
2793
 
        multiprocessing.active_children()
2794
 
        wnull.close()
 
3494
 
 
3495
        mp.active_children()
 
3496
        wn.close()
2795
3497
        if not (tcp_server.clients or client_settings):
2796
3498
            return
2797
 
        
 
3499
 
2798
3500
        # Store client before exiting. Secrets are encrypted with key
2799
3501
        # based on what config file has. If config file is
2800
3502
        # removed/edited, old secret will thus be unrecovable.
2801
3503
        clients = {}
2802
3504
        with PGPEngine() as pgp:
2803
 
            for client in tcp_server.clients.itervalues():
 
3505
            for client in tcp_server.clients.values():
2804
3506
                key = client_settings[client.name]["secret"]
2805
3507
                client.encrypted_secret = pgp.encrypt(client.secret,
2806
3508
                                                      key)
2807
3509
                client_dict = {}
2808
 
                
 
3510
 
2809
3511
                # A list of attributes that can not be pickled
2810
3512
                # + secret.
2811
 
                exclude = { "bus", "changedstate", "secret",
2812
 
                            "checker", "server_settings" }
 
3513
                exclude = {"bus", "changedstate", "secret",
 
3514
                           "checker", "server_settings"}
2813
3515
                for name, typ in inspect.getmembers(dbus.service
2814
3516
                                                    .Object):
2815
3517
                    exclude.add(name)
2816
 
                
 
3518
 
2817
3519
                client_dict["encrypted_secret"] = (client
2818
3520
                                                   .encrypted_secret)
2819
3521
                for attr in client.client_structure:
2820
3522
                    if attr not in exclude:
2821
3523
                        client_dict[attr] = getattr(client, attr)
2822
 
                
 
3524
 
2823
3525
                clients[client.name] = client_dict
2824
3526
                del client_settings[client.name]["secret"]
2825
 
        
 
3527
 
2826
3528
        try:
2827
3529
            with tempfile.NamedTemporaryFile(
2828
3530
                    mode='wb',
2830
3532
                    prefix='clients-',
2831
3533
                    dir=os.path.dirname(stored_state_path),
2832
3534
                    delete=False) as stored_state:
2833
 
                pickle.dump((clients, client_settings), stored_state)
 
3535
                pickle.dump((clients, client_settings), stored_state,
 
3536
                            protocol=2)
2834
3537
                tempname = stored_state.name
2835
3538
            os.rename(tempname, stored_state_path)
2836
3539
        except (IOError, OSError) as e:
2846
3549
                logger.warning("Could not save persistent state:",
2847
3550
                               exc_info=e)
2848
3551
                raise
2849
 
        
 
3552
 
2850
3553
        # Delete all clients, and settings from config
2851
3554
        while tcp_server.clients:
2852
3555
            name, client = tcp_server.clients.popitem()
2853
3556
            if use_dbus:
2854
3557
                client.remove_from_connection()
2855
 
            # Don't signal anything except ClientRemoved
 
3558
            # Don't signal the disabling
2856
3559
            client.disable(quiet=True)
 
3560
            # Emit D-Bus signal for removal
2857
3561
            if use_dbus:
2858
 
                # Emit D-Bus signal
2859
 
                mandos_dbus_service.ClientRemoved(
2860
 
                    client.dbus_object_path, client.name)
 
3562
                mandos_dbus_service.client_removed_signal(client)
2861
3563
        client_settings.clear()
2862
 
    
 
3564
 
2863
3565
    atexit.register(cleanup)
2864
 
    
2865
 
    for client in tcp_server.clients.itervalues():
 
3566
 
 
3567
    for client in tcp_server.clients.values():
2866
3568
        if use_dbus:
2867
 
            # Emit D-Bus signal
2868
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3569
            # Emit D-Bus signal for adding
 
3570
            mandos_dbus_service.client_added_signal(client)
2869
3571
        # Need to initiate checking of clients
2870
3572
        if client.enabled:
2871
3573
            client.init_checker()
2872
 
    
 
3574
 
2873
3575
    tcp_server.enable()
2874
3576
    tcp_server.server_activate()
2875
 
    
 
3577
 
2876
3578
    # Find out what port we got
2877
3579
    if zeroconf:
2878
3580
        service.port = tcp_server.socket.getsockname()[1]
2883
3585
    else:                       # IPv4
2884
3586
        logger.info("Now listening on address %r, port %d",
2885
3587
                    *tcp_server.socket.getsockname())
2886
 
    
2887
 
    #service.interface = tcp_server.socket.getsockname()[3]
2888
 
    
 
3588
 
 
3589
    # service.interface = tcp_server.socket.getsockname()[3]
 
3590
 
2889
3591
    try:
2890
3592
        if zeroconf:
2891
3593
            # From the Avahi example code
2896
3598
                cleanup()
2897
3599
                sys.exit(1)
2898
3600
            # End of Avahi example code
2899
 
        
2900
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2901
 
                             lambda *args, **kwargs:
2902
 
                             (tcp_server.handle_request
2903
 
                              (*args[2:], **kwargs) or True))
2904
 
        
 
3601
 
 
3602
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3603
                          lambda *args, **kwargs:
 
3604
                          (tcp_server.handle_request
 
3605
                           (*args[2:], **kwargs) or True))
 
3606
 
2905
3607
        logger.debug("Starting main loop")
2906
3608
        main_loop.run()
2907
3609
    except AvahiError as error: