/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-02-09 23:23:26 UTC
  • Revision ID: teddy@recompile.se-20190209232326-z1z2kzpgfixz7iaj
Add support for using raw public keys in TLS (RFC 7250)

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

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

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos
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)
412
479
                logger.debug("Unknown state: %r", state)
413
480
            else:
414
481
                logger.debug("Unknown state: %r: %r", state, error)
415
 
    
 
482
 
416
483
    def activate(self):
417
484
        """Derived from the Avahi example code"""
418
485
        if self.server is None:
429
496
class AvahiServiceToSyslog(AvahiService):
430
497
    def rename(self, *args, **kwargs):
431
498
        """Add the new name to the syslog messages"""
432
 
        ret = AvahiService.rename(self, *args, **kwargs)
 
499
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
433
500
        syslogger.setFormatter(logging.Formatter(
434
501
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
435
502
            .format(self.name)))
436
503
        return ret
437
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
 
438
817
def call_pipe(connection,       # : multiprocessing.Connection
439
818
              func, *args, **kwargs):
440
819
    """This function is meant to be called by multiprocessing.Process
441
 
    
 
820
 
442
821
    This function runs func(*args, **kwargs), and writes the resulting
443
822
    return value on the provided multiprocessing.Connection.
444
823
    """
445
824
    connection.send(func(*args, **kwargs))
446
825
    connection.close()
447
826
 
 
827
 
448
828
class Client(object):
449
829
    """A representation of a client host served by this server.
450
 
    
 
830
 
451
831
    Attributes:
452
832
    approved:   bool(); 'None' if not yet approved/disapproved
453
833
    approval_delay: datetime.timedelta(); Time to wait for approval
455
835
    checker:    subprocess.Popen(); a running checker process used
456
836
                                    to see if the client lives.
457
837
                                    'None' if no process is running.
458
 
    checker_callback_tag: a gobject event source tag, or None
 
838
    checker_callback_tag: a GLib event source tag, or None
459
839
    checker_command: string; External command which is run to check
460
840
                     if client lives.  %() expansions are done at
461
841
                     runtime with vars(self) as dict, so that for
462
842
                     instance %(name)s can be used in the command.
463
 
    checker_initiator_tag: a gobject event source tag, or None
 
843
    checker_initiator_tag: a GLib event source tag, or None
464
844
    created:    datetime.datetime(); (UTC) object creation
465
845
    client_structure: Object describing what attributes a client has
466
846
                      and is used for storing the client at exit
467
847
    current_checker_command: string; current running checker_command
468
 
    disable_initiator_tag: a gobject event source tag, or None
 
848
    disable_initiator_tag: a GLib event source tag, or None
469
849
    enabled:    bool()
470
850
    fingerprint: string (40 or 32 hexadecimal digits); used to
471
 
                 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
472
854
    host:       string; available for use by the checker command
473
855
    interval:   datetime.timedelta(); How often to start a new checker
474
856
    last_approval_request: datetime.datetime(); (UTC) or None
490
872
                disabled, or None
491
873
    server_settings: The server_settings dict from main()
492
874
    """
493
 
    
 
875
 
494
876
    runtime_expansions = ("approval_delay", "approval_duration",
495
 
                          "created", "enabled", "expires",
 
877
                          "created", "enabled", "expires", "key_id",
496
878
                          "fingerprint", "host", "interval",
497
879
                          "last_approval_request", "last_checked_ok",
498
880
                          "last_enabled", "name", "timeout")
507
889
        "approved_by_default": "True",
508
890
        "enabled": "True",
509
891
    }
510
 
    
 
892
 
511
893
    @staticmethod
512
894
    def config_parser(config):
513
895
        """Construct a new dict of client settings of this form:
520
902
        for client_name in config.sections():
521
903
            section = dict(config.items(client_name))
522
904
            client = settings[client_name] = {}
523
 
            
 
905
 
524
906
            client["host"] = section["host"]
525
907
            # Reformat values from string types to Python types
526
908
            client["approved_by_default"] = config.getboolean(
527
909
                client_name, "approved_by_default")
528
910
            client["enabled"] = config.getboolean(client_name,
529
911
                                                  "enabled")
530
 
            
531
 
            # Uppercase and remove spaces from fingerprint for later
532
 
            # comparison purposes with return value from the
533
 
            # 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(" ", ""))
534
918
            client["fingerprint"] = (section["fingerprint"].upper()
535
919
                                     .replace(" ", ""))
536
920
            if "secret" in section:
537
 
                client["secret"] = section["secret"].decode("base64")
 
921
                client["secret"] = codecs.decode(section["secret"]
 
922
                                                 .encode("utf-8"),
 
923
                                                 "base64")
538
924
            elif "secfile" in section:
539
925
                with open(os.path.expanduser(os.path.expandvars
540
926
                                             (section["secfile"])),
555
941
            client["last_approval_request"] = None
556
942
            client["last_checked_ok"] = None
557
943
            client["last_checker_status"] = -2
558
 
        
 
944
 
559
945
        return settings
560
 
    
561
 
    def __init__(self, settings, name = None, server_settings=None):
 
946
 
 
947
    def __init__(self, settings, name=None, server_settings=None):
562
948
        self.name = name
563
949
        if server_settings is None:
564
950
            server_settings = {}
566
952
        # adding all client settings
567
953
        for setting, value in settings.items():
568
954
            setattr(self, setting, value)
569
 
        
 
955
 
570
956
        if self.enabled:
571
957
            if not hasattr(self, "last_enabled"):
572
958
                self.last_enabled = datetime.datetime.utcnow()
576
962
        else:
577
963
            self.last_enabled = None
578
964
            self.expires = None
579
 
        
 
965
 
580
966
        logger.debug("Creating client %r", self.name)
 
967
        logger.debug("  Key ID: %s", self.key_id)
581
968
        logger.debug("  Fingerprint: %s", self.fingerprint)
582
969
        self.created = settings.get("created",
583
970
                                    datetime.datetime.utcnow())
584
 
        
 
971
 
585
972
        # attributes specific for this server instance
586
973
        self.checker = None
587
974
        self.checker_initiator_tag = None
593
980
        self.changedstate = multiprocessing_manager.Condition(
594
981
            multiprocessing_manager.Lock())
595
982
        self.client_structure = [attr
596
 
                                 for attr in self.__dict__.iterkeys()
 
983
                                 for attr in self.__dict__.keys()
597
984
                                 if not attr.startswith("_")]
598
985
        self.client_structure.append("client_structure")
599
 
        
 
986
 
600
987
        for name, t in inspect.getmembers(
601
988
                type(self), lambda obj: isinstance(obj, property)):
602
989
            if not name.startswith("_"):
603
990
                self.client_structure.append(name)
604
 
    
 
991
 
605
992
    # Send notice to process children that client state has changed
606
993
    def send_changedstate(self):
607
994
        with self.changedstate:
608
995
            self.changedstate.notify_all()
609
 
    
 
996
 
610
997
    def enable(self):
611
998
        """Start this client's checker and timeout hooks"""
612
999
        if getattr(self, "enabled", False):
617
1004
        self.last_enabled = datetime.datetime.utcnow()
618
1005
        self.init_checker()
619
1006
        self.send_changedstate()
620
 
    
 
1007
 
621
1008
    def disable(self, quiet=True):
622
1009
        """Disable this client."""
623
1010
        if not getattr(self, "enabled", False):
625
1012
        if not quiet:
626
1013
            logger.info("Disabling client %s", self.name)
627
1014
        if getattr(self, "disable_initiator_tag", None) is not None:
628
 
            gobject.source_remove(self.disable_initiator_tag)
 
1015
            GLib.source_remove(self.disable_initiator_tag)
629
1016
            self.disable_initiator_tag = None
630
1017
        self.expires = None
631
1018
        if getattr(self, "checker_initiator_tag", None) is not None:
632
 
            gobject.source_remove(self.checker_initiator_tag)
 
1019
            GLib.source_remove(self.checker_initiator_tag)
633
1020
            self.checker_initiator_tag = None
634
1021
        self.stop_checker()
635
1022
        self.enabled = False
636
1023
        if not quiet:
637
1024
            self.send_changedstate()
638
 
        # 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
639
1026
        return False
640
 
    
 
1027
 
641
1028
    def __del__(self):
642
1029
        self.disable()
643
 
    
 
1030
 
644
1031
    def init_checker(self):
645
1032
        # Schedule a new checker to be started an 'interval' from now,
646
1033
        # and every interval from then on.
647
1034
        if self.checker_initiator_tag is not None:
648
 
            gobject.source_remove(self.checker_initiator_tag)
649
 
        self.checker_initiator_tag = gobject.timeout_add(
 
1035
            GLib.source_remove(self.checker_initiator_tag)
 
1036
        self.checker_initiator_tag = GLib.timeout_add(
650
1037
            int(self.interval.total_seconds() * 1000),
651
1038
            self.start_checker)
652
1039
        # Schedule a disable() when 'timeout' has passed
653
1040
        if self.disable_initiator_tag is not None:
654
 
            gobject.source_remove(self.disable_initiator_tag)
655
 
        self.disable_initiator_tag = gobject.timeout_add(
 
1041
            GLib.source_remove(self.disable_initiator_tag)
 
1042
        self.disable_initiator_tag = GLib.timeout_add(
656
1043
            int(self.timeout.total_seconds() * 1000), self.disable)
657
1044
        # Also start a new checker *right now*.
658
1045
        self.start_checker()
659
 
    
 
1046
 
660
1047
    def checker_callback(self, source, condition, connection,
661
1048
                         command):
662
1049
        """The checker has completed, so take appropriate actions."""
665
1052
        # Read return code from connection (see call_pipe)
666
1053
        returncode = connection.recv()
667
1054
        connection.close()
668
 
        
 
1055
 
669
1056
        if returncode >= 0:
670
1057
            self.last_checker_status = returncode
671
1058
            self.last_checker_signal = None
681
1068
            logger.warning("Checker for %(name)s crashed?",
682
1069
                           vars(self))
683
1070
        return False
684
 
    
 
1071
 
685
1072
    def checked_ok(self):
686
1073
        """Assert that the client has been seen, alive and well."""
687
1074
        self.last_checked_ok = datetime.datetime.utcnow()
688
1075
        self.last_checker_status = 0
689
1076
        self.last_checker_signal = None
690
1077
        self.bump_timeout()
691
 
    
 
1078
 
692
1079
    def bump_timeout(self, timeout=None):
693
1080
        """Bump up the timeout for this client."""
694
1081
        if timeout is None:
695
1082
            timeout = self.timeout
696
1083
        if self.disable_initiator_tag is not None:
697
 
            gobject.source_remove(self.disable_initiator_tag)
 
1084
            GLib.source_remove(self.disable_initiator_tag)
698
1085
            self.disable_initiator_tag = None
699
1086
        if getattr(self, "enabled", False):
700
 
            self.disable_initiator_tag = gobject.timeout_add(
 
1087
            self.disable_initiator_tag = GLib.timeout_add(
701
1088
                int(timeout.total_seconds() * 1000), self.disable)
702
1089
            self.expires = datetime.datetime.utcnow() + timeout
703
 
    
 
1090
 
704
1091
    def need_approval(self):
705
1092
        self.last_approval_request = datetime.datetime.utcnow()
706
 
    
 
1093
 
707
1094
    def start_checker(self):
708
1095
        """Start a new checker subprocess if one is not running.
709
 
        
 
1096
 
710
1097
        If a checker already exists, leave it running and do
711
1098
        nothing."""
712
1099
        # The reason for not killing a running checker is that if we
717
1104
        # checkers alone, the checker would have to take more time
718
1105
        # than 'timeout' for the client to be disabled, which is as it
719
1106
        # should be.
720
 
        
 
1107
 
721
1108
        if self.checker is not None and not self.checker.is_alive():
722
1109
            logger.warning("Checker was not alive; joining")
723
1110
            self.checker.join()
727
1114
            # Escape attributes for the shell
728
1115
            escaped_attrs = {
729
1116
                attr: re.escape(str(getattr(self, attr)))
730
 
                for attr in self.runtime_expansions }
 
1117
                for attr in self.runtime_expansions}
731
1118
            try:
732
1119
                command = self.checker_command % escaped_attrs
733
1120
            except TypeError as error:
745
1132
            # The exception is when not debugging but nevertheless
746
1133
            # running in the foreground; use the previously
747
1134
            # created wnull.
748
 
            popen_args = { "close_fds": True,
749
 
                           "shell": True,
750
 
                           "cwd": "/" }
 
1135
            popen_args = {"close_fds": True,
 
1136
                          "shell": True,
 
1137
                          "cwd": "/"}
751
1138
            if (not self.server_settings["debug"]
752
1139
                and self.server_settings["foreground"]):
753
1140
                popen_args.update({"stdout": wnull,
754
 
                                   "stderr": wnull })
755
 
            pipe = multiprocessing.Pipe(duplex = False)
 
1141
                                   "stderr": wnull})
 
1142
            pipe = multiprocessing.Pipe(duplex=False)
756
1143
            self.checker = multiprocessing.Process(
757
 
                target = call_pipe,
758
 
                args = (pipe[1], subprocess.call, command),
759
 
                kwargs = popen_args)
 
1144
                target=call_pipe,
 
1145
                args=(pipe[1], subprocess.call, command),
 
1146
                kwargs=popen_args)
760
1147
            self.checker.start()
761
 
            self.checker_callback_tag = gobject.io_add_watch(
762
 
                pipe[0].fileno(), gobject.IO_IN,
 
1148
            self.checker_callback_tag = GLib.io_add_watch(
 
1149
                pipe[0].fileno(), GLib.IO_IN,
763
1150
                self.checker_callback, pipe[0], command)
764
 
        # Re-run this periodically if run by gobject.timeout_add
 
1151
        # Re-run this periodically if run by GLib.timeout_add
765
1152
        return True
766
 
    
 
1153
 
767
1154
    def stop_checker(self):
768
1155
        """Force the checker process, if any, to stop."""
769
1156
        if self.checker_callback_tag:
770
 
            gobject.source_remove(self.checker_callback_tag)
 
1157
            GLib.source_remove(self.checker_callback_tag)
771
1158
            self.checker_callback_tag = None
772
1159
        if getattr(self, "checker", None) is None:
773
1160
            return
782
1169
                          byte_arrays=False):
783
1170
    """Decorators for marking methods of a DBusObjectWithProperties to
784
1171
    become properties on the D-Bus.
785
 
    
 
1172
 
786
1173
    The decorated method will be called with no arguments by "Get"
787
1174
    and with one argument by "Set".
788
 
    
 
1175
 
789
1176
    The parameters, where they are supported, are the same as
790
1177
    dbus.service.method, except there is only "signature", since the
791
1178
    type from Get() and the type sent to Set() is the same.
795
1182
    if byte_arrays and signature != "ay":
796
1183
        raise ValueError("Byte arrays not supported for non-'ay'"
797
1184
                         " signature {!r}".format(signature))
798
 
    
 
1185
 
799
1186
    def decorator(func):
800
1187
        func._dbus_is_property = True
801
1188
        func._dbus_interface = dbus_interface
804
1191
        func._dbus_name = func.__name__
805
1192
        if func._dbus_name.endswith("_dbus_property"):
806
1193
            func._dbus_name = func._dbus_name[:-14]
807
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
1194
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
808
1195
        return func
809
 
    
 
1196
 
810
1197
    return decorator
811
1198
 
812
1199
 
813
1200
def dbus_interface_annotations(dbus_interface):
814
1201
    """Decorator for marking functions returning interface annotations
815
 
    
 
1202
 
816
1203
    Usage:
817
 
    
 
1204
 
818
1205
    @dbus_interface_annotations("org.example.Interface")
819
1206
    def _foo(self):  # Function name does not matter
820
1207
        return {"org.freedesktop.DBus.Deprecated": "true",
821
1208
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
822
1209
                    "false"}
823
1210
    """
824
 
    
 
1211
 
825
1212
    def decorator(func):
826
1213
        func._dbus_is_interface = True
827
1214
        func._dbus_interface = dbus_interface
828
1215
        func._dbus_name = dbus_interface
829
1216
        return func
830
 
    
 
1217
 
831
1218
    return decorator
832
1219
 
833
1220
 
834
1221
def dbus_annotations(annotations):
835
1222
    """Decorator to annotate D-Bus methods, signals or properties
836
1223
    Usage:
837
 
    
 
1224
 
838
1225
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
839
1226
                       "org.freedesktop.DBus.Property."
840
1227
                       "EmitsChangedSignal": "false"})
842
1229
                           access="r")
843
1230
    def Property_dbus_property(self):
844
1231
        return dbus.Boolean(False)
 
1232
 
 
1233
    See also the DBusObjectWithAnnotations class.
845
1234
    """
846
 
    
 
1235
 
847
1236
    def decorator(func):
848
1237
        func._dbus_annotations = annotations
849
1238
        return func
850
 
    
 
1239
 
851
1240
    return decorator
852
1241
 
853
1242
 
869
1258
    pass
870
1259
 
871
1260
 
872
 
class DBusObjectWithProperties(dbus.service.Object):
873
 
    """A D-Bus object with properties.
874
 
    
875
 
    Classes inheriting from this can use the dbus_service_property
876
 
    decorator to expose methods as D-Bus properties.  It exposes the
877
 
    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.
878
1266
    """
879
 
    
 
1267
 
880
1268
    @staticmethod
881
1269
    def _is_dbus_thing(thing):
882
1270
        """Returns a function testing if an attribute is a D-Bus thing
883
 
        
 
1271
 
884
1272
        If called like _is_dbus_thing("method") it returns a function
885
1273
        suitable for use as predicate to inspect.getmembers().
886
1274
        """
887
1275
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
888
1276
                                   False)
889
 
    
 
1277
 
890
1278
    def _get_all_dbus_things(self, thing):
891
1279
        """Returns a generator of (name, attribute) pairs
892
1280
        """
895
1283
                for cls in self.__class__.__mro__
896
1284
                for name, athing in
897
1285
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
898
 
    
 
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
 
899
1358
    def _get_dbus_property(self, interface_name, property_name):
900
1359
        """Returns a bound method if one exists which is a D-Bus
901
1360
        property with the specified name and interface.
906
1365
                if (value._dbus_name == property_name
907
1366
                    and value._dbus_interface == interface_name):
908
1367
                    return value.__get__(self)
909
 
        
 
1368
 
910
1369
        # No such property
911
1370
        raise DBusPropertyNotFound("{}:{}.{}".format(
912
1371
            self.dbus_object_path, interface_name, property_name))
913
 
    
 
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
 
914
1382
    @dbus.service.method(dbus.PROPERTIES_IFACE,
915
1383
                         in_signature="ss",
916
1384
                         out_signature="v")
924
1392
        if not hasattr(value, "variant_level"):
925
1393
            return value
926
1394
        return type(value)(value, variant_level=value.variant_level+1)
927
 
    
 
1395
 
928
1396
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
929
1397
    def Set(self, interface_name, property_name, value):
930
1398
        """Standard D-Bus property Set() method, see D-Bus standard.
942
1410
            value = dbus.ByteArray(b''.join(chr(byte)
943
1411
                                            for byte in value))
944
1412
        prop(value)
945
 
    
 
1413
 
946
1414
    @dbus.service.method(dbus.PROPERTIES_IFACE,
947
1415
                         in_signature="s",
948
1416
                         out_signature="a{sv}")
949
1417
    def GetAll(self, interface_name):
950
1418
        """Standard D-Bus property GetAll() method, see D-Bus
951
1419
        standard.
952
 
        
 
1420
 
953
1421
        Note: Will not include properties with access="write".
954
1422
        """
955
1423
        properties = {}
966
1434
                properties[name] = value
967
1435
                continue
968
1436
            properties[name] = type(value)(
969
 
                value, variant_level = value.variant_level + 1)
 
1437
                value, variant_level=value.variant_level + 1)
970
1438
        return dbus.Dictionary(properties, signature="sv")
971
 
    
 
1439
 
972
1440
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
973
1441
    def PropertiesChanged(self, interface_name, changed_properties,
974
1442
                          invalidated_properties):
976
1444
        standard.
977
1445
        """
978
1446
        pass
979
 
    
 
1447
 
980
1448
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
981
1449
                         out_signature="s",
982
1450
                         path_keyword='object_path',
983
1451
                         connection_keyword='connection')
984
1452
    def Introspect(self, object_path, connection):
985
1453
        """Overloading of standard D-Bus method.
986
 
        
 
1454
 
987
1455
        Inserts property tags and interface annotation tags.
988
1456
        """
989
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
990
 
                                                   connection)
 
1457
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1458
                                                         object_path,
 
1459
                                                         connection)
991
1460
        try:
992
1461
            document = xml.dom.minidom.parseString(xmlstring)
993
 
            
 
1462
 
994
1463
            def make_tag(document, name, prop):
995
1464
                e = document.createElement("property")
996
1465
                e.setAttribute("name", name)
997
1466
                e.setAttribute("type", prop._dbus_signature)
998
1467
                e.setAttribute("access", prop._dbus_access)
999
1468
                return e
1000
 
            
 
1469
 
1001
1470
            for if_tag in document.getElementsByTagName("interface"):
1002
1471
                # Add property tags
1003
1472
                for tag in (make_tag(document, name, prop)
1006
1475
                            if prop._dbus_interface
1007
1476
                            == if_tag.getAttribute("name")):
1008
1477
                    if_tag.appendChild(tag)
1009
 
                # Add annotation tags
1010
 
                for typ in ("method", "signal", "property"):
1011
 
                    for tag in if_tag.getElementsByTagName(typ):
1012
 
                        annots = dict()
1013
 
                        for name, prop in (self.
1014
 
                                           _get_all_dbus_things(typ)):
1015
 
                            if (name == tag.getAttribute("name")
1016
 
                                and prop._dbus_interface
1017
 
                                == if_tag.getAttribute("name")):
1018
 
                                annots.update(getattr(
1019
 
                                    prop, "_dbus_annotations", {}))
1020
 
                        for name, value in annots.items():
1021
 
                            ann_tag = document.createElement(
1022
 
                                "annotation")
1023
 
                            ann_tag.setAttribute("name", name)
1024
 
                            ann_tag.setAttribute("value", value)
1025
 
                            tag.appendChild(ann_tag)
1026
 
                # Add interface annotation tags
1027
 
                for annotation, value in dict(
1028
 
                    itertools.chain.from_iterable(
1029
 
                        annotations().items()
1030
 
                        for name, annotations
1031
 
                        in self._get_all_dbus_things("interface")
1032
 
                        if name == if_tag.getAttribute("name")
1033
 
                        )).items():
1034
 
                    ann_tag = document.createElement("annotation")
1035
 
                    ann_tag.setAttribute("name", annotation)
1036
 
                    ann_tag.setAttribute("value", value)
1037
 
                    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)
1038
1494
                # Add the names to the return values for the
1039
1495
                # "org.freedesktop.DBus.Properties" methods
1040
1496
                if (if_tag.getAttribute("name")
1059
1515
        return xmlstring
1060
1516
 
1061
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
 
1062
1589
def datetime_to_dbus(dt, variant_level=0):
1063
1590
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1064
1591
    if dt is None:
1065
 
        return dbus.String("", variant_level = variant_level)
 
1592
        return dbus.String("", variant_level=variant_level)
1066
1593
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1067
1594
 
1068
1595
 
1071
1598
    dbus.service.Object, it will add alternate D-Bus attributes with
1072
1599
    interface names according to the "alt_interface_names" mapping.
1073
1600
    Usage:
1074
 
    
 
1601
 
1075
1602
    @alternate_dbus_interfaces({"org.example.Interface":
1076
1603
                                    "net.example.AlternateInterface"})
1077
1604
    class SampleDBusObject(dbus.service.Object):
1078
1605
        @dbus.service.method("org.example.Interface")
1079
1606
        def SampleDBusMethod():
1080
1607
            pass
1081
 
    
 
1608
 
1082
1609
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1083
1610
    reachable via two interfaces: "org.example.Interface" and
1084
1611
    "net.example.AlternateInterface", the latter of which will have
1085
1612
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1086
1613
    "true", unless "deprecate" is passed with a False value.
1087
 
    
 
1614
 
1088
1615
    This works for methods and signals, and also for D-Bus properties
1089
1616
    (from DBusObjectWithProperties) and interfaces (from the
1090
1617
    dbus_interface_annotations decorator).
1091
1618
    """
1092
 
    
 
1619
 
1093
1620
    def wrapper(cls):
1094
1621
        for orig_interface_name, alt_interface_name in (
1095
1622
                alt_interface_names.items()):
1110
1637
                interface_names.add(alt_interface)
1111
1638
                # Is this a D-Bus signal?
1112
1639
                if getattr(attribute, "_dbus_is_signal", False):
 
1640
                    # Extract the original non-method undecorated
 
1641
                    # function by black magic
1113
1642
                    if sys.version_info.major == 2:
1114
 
                        # Extract the original non-method undecorated
1115
 
                        # function by black magic
1116
1643
                        nonmethod_func = (dict(
1117
1644
                            zip(attribute.func_code.co_freevars,
1118
1645
                                attribute.__closure__))
1119
1646
                                          ["func"].cell_contents)
1120
1647
                    else:
1121
 
                        nonmethod_func = attribute
 
1648
                        nonmethod_func = (dict(
 
1649
                            zip(attribute.__code__.co_freevars,
 
1650
                                attribute.__closure__))
 
1651
                                          ["func"].cell_contents)
1122
1652
                    # Create a new, but exactly alike, function
1123
1653
                    # object, and decorate it to be a new D-Bus signal
1124
1654
                    # with the alternate D-Bus interface name
1125
 
                    if sys.version_info.major == 2:
1126
 
                        new_function = types.FunctionType(
1127
 
                            nonmethod_func.func_code,
1128
 
                            nonmethod_func.func_globals,
1129
 
                            nonmethod_func.func_name,
1130
 
                            nonmethod_func.func_defaults,
1131
 
                            nonmethod_func.func_closure)
1132
 
                    else:
1133
 
                        new_function = types.FunctionType(
1134
 
                            nonmethod_func.__code__,
1135
 
                            nonmethod_func.__globals__,
1136
 
                            nonmethod_func.__name__,
1137
 
                            nonmethod_func.__defaults__,
1138
 
                            nonmethod_func.__closure__)
 
1655
                    new_function = copy_function(nonmethod_func)
1139
1656
                    new_function = (dbus.service.signal(
1140
1657
                        alt_interface,
1141
1658
                        attribute._dbus_signature)(new_function))
1145
1662
                            attribute._dbus_annotations)
1146
1663
                    except AttributeError:
1147
1664
                        pass
 
1665
 
1148
1666
                    # Define a creator of a function to call both the
1149
1667
                    # original and alternate functions, so both the
1150
1668
                    # original and alternate signals gets sent when
1153
1671
                        """This function is a scope container to pass
1154
1672
                        func1 and func2 to the "call_both" function
1155
1673
                        outside of its arguments"""
1156
 
                        
 
1674
 
 
1675
                        @functools.wraps(func2)
1157
1676
                        def call_both(*args, **kwargs):
1158
1677
                            """This function will emit two D-Bus
1159
1678
                            signals by calling func1 and func2"""
1160
1679
                            func1(*args, **kwargs)
1161
1680
                            func2(*args, **kwargs)
1162
 
                        
 
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
 
1163
1687
                        return call_both
1164
1688
                    # Create the "call_both" function and add it to
1165
1689
                    # the class
1175
1699
                            alt_interface,
1176
1700
                            attribute._dbus_in_signature,
1177
1701
                            attribute._dbus_out_signature)
1178
 
                        (types.FunctionType(attribute.func_code,
1179
 
                                            attribute.func_globals,
1180
 
                                            attribute.func_name,
1181
 
                                            attribute.func_defaults,
1182
 
                                            attribute.func_closure)))
 
1702
                        (copy_function(attribute)))
1183
1703
                    # Copy annotations, if any
1184
1704
                    try:
1185
1705
                        attr[attrname]._dbus_annotations = dict(
1197
1717
                        attribute._dbus_access,
1198
1718
                        attribute._dbus_get_args_options
1199
1719
                        ["byte_arrays"])
1200
 
                                      (types.FunctionType(
1201
 
                                          attribute.func_code,
1202
 
                                          attribute.func_globals,
1203
 
                                          attribute.func_name,
1204
 
                                          attribute.func_defaults,
1205
 
                                          attribute.func_closure)))
 
1720
                                      (copy_function(attribute)))
1206
1721
                    # Copy annotations, if any
1207
1722
                    try:
1208
1723
                        attr[attrname]._dbus_annotations = dict(
1217
1732
                    # to the class.
1218
1733
                    attr[attrname] = (
1219
1734
                        dbus_interface_annotations(alt_interface)
1220
 
                        (types.FunctionType(attribute.func_code,
1221
 
                                            attribute.func_globals,
1222
 
                                            attribute.func_name,
1223
 
                                            attribute.func_defaults,
1224
 
                                            attribute.func_closure)))
 
1735
                        (copy_function(attribute)))
1225
1736
            if deprecate:
1226
1737
                # Deprecate all alternate interfaces
1227
 
                iname="_AlternateDBusNames_interface_annotation{}"
 
1738
                iname = "_AlternateDBusNames_interface_annotation{}"
1228
1739
                for interface_name in interface_names:
1229
 
                    
 
1740
 
1230
1741
                    @dbus_interface_annotations(interface_name)
1231
1742
                    def func(self):
1232
 
                        return { "org.freedesktop.DBus.Deprecated":
1233
 
                                 "true" }
 
1743
                        return {"org.freedesktop.DBus.Deprecated":
 
1744
                                "true"}
1234
1745
                    # Find an unused name
1235
1746
                    for aname in (iname.format(i)
1236
1747
                                  for i in itertools.count()):
1240
1751
            if interface_names:
1241
1752
                # Replace the class with a new subclass of it with
1242
1753
                # methods, signals, etc. as created above.
1243
 
                cls = type(b"{}Alternate".format(cls.__name__),
1244
 
                           (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)
1245
1760
        return cls
1246
 
    
 
1761
 
1247
1762
    return wrapper
1248
1763
 
1249
1764
 
1251
1766
                            "se.bsnet.fukt.Mandos"})
1252
1767
class ClientDBus(Client, DBusObjectWithProperties):
1253
1768
    """A Client class using D-Bus
1254
 
    
 
1769
 
1255
1770
    Attributes:
1256
1771
    dbus_object_path: dbus.ObjectPath
1257
1772
    bus: dbus.SystemBus()
1258
1773
    """
1259
 
    
 
1774
 
1260
1775
    runtime_expansions = (Client.runtime_expansions
1261
1776
                          + ("dbus_object_path", ))
1262
 
    
 
1777
 
1263
1778
    _interface = "se.recompile.Mandos.Client"
1264
 
    
 
1779
 
1265
1780
    # dbus.service.Object doesn't use super(), so we can't either.
1266
 
    
1267
 
    def __init__(self, bus = None, *args, **kwargs):
 
1781
 
 
1782
    def __init__(self, bus=None, *args, **kwargs):
1268
1783
        self.bus = bus
1269
1784
        Client.__init__(self, *args, **kwargs)
1270
1785
        # Only now, when this client is initialized, can it show up on
1276
1791
            "/clients/" + client_object_name)
1277
1792
        DBusObjectWithProperties.__init__(self, self.bus,
1278
1793
                                          self.dbus_object_path)
1279
 
    
 
1794
 
1280
1795
    def notifychangeproperty(transform_func, dbus_name,
1281
1796
                             type_func=lambda x: x,
1282
1797
                             variant_level=1,
1284
1799
                             _interface=_interface):
1285
1800
        """ Modify a variable so that it's a property which announces
1286
1801
        its changes to DBus.
1287
 
        
 
1802
 
1288
1803
        transform_fun: Function that takes a value and a variant_level
1289
1804
                       and transforms it to a D-Bus type.
1290
1805
        dbus_name: D-Bus name of the variable
1293
1808
        variant_level: D-Bus variant level.  Default: 1
1294
1809
        """
1295
1810
        attrname = "_{}".format(dbus_name)
1296
 
        
 
1811
 
1297
1812
        def setter(self, value):
1298
1813
            if hasattr(self, "dbus_object_path"):
1299
1814
                if (not hasattr(self, attrname) or
1306
1821
                    else:
1307
1822
                        dbus_value = transform_func(
1308
1823
                            type_func(value),
1309
 
                            variant_level = variant_level)
 
1824
                            variant_level=variant_level)
1310
1825
                        self.PropertyChanged(dbus.String(dbus_name),
1311
1826
                                             dbus_value)
1312
1827
                        self.PropertiesChanged(
1313
1828
                            _interface,
1314
 
                            dbus.Dictionary({ dbus.String(dbus_name):
1315
 
                                              dbus_value }),
 
1829
                            dbus.Dictionary({dbus.String(dbus_name):
 
1830
                                             dbus_value}),
1316
1831
                            dbus.Array())
1317
1832
            setattr(self, attrname, value)
1318
 
        
 
1833
 
1319
1834
        return property(lambda self: getattr(self, attrname), setter)
1320
 
    
 
1835
 
1321
1836
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1322
1837
    approvals_pending = notifychangeproperty(dbus.Boolean,
1323
1838
                                             "ApprovalPending",
1324
 
                                             type_func = bool)
 
1839
                                             type_func=bool)
1325
1840
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1326
1841
    last_enabled = notifychangeproperty(datetime_to_dbus,
1327
1842
                                        "LastEnabled")
1328
1843
    checker = notifychangeproperty(
1329
1844
        dbus.Boolean, "CheckerRunning",
1330
 
        type_func = lambda checker: checker is not None)
 
1845
        type_func=lambda checker: checker is not None)
1331
1846
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1332
1847
                                           "LastCheckedOK")
1333
1848
    last_checker_status = notifychangeproperty(dbus.Int16,
1338
1853
                                               "ApprovedByDefault")
1339
1854
    approval_delay = notifychangeproperty(
1340
1855
        dbus.UInt64, "ApprovalDelay",
1341
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1856
        type_func=lambda td: td.total_seconds() * 1000)
1342
1857
    approval_duration = notifychangeproperty(
1343
1858
        dbus.UInt64, "ApprovalDuration",
1344
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1859
        type_func=lambda td: td.total_seconds() * 1000)
1345
1860
    host = notifychangeproperty(dbus.String, "Host")
1346
1861
    timeout = notifychangeproperty(
1347
1862
        dbus.UInt64, "Timeout",
1348
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1863
        type_func=lambda td: td.total_seconds() * 1000)
1349
1864
    extended_timeout = notifychangeproperty(
1350
1865
        dbus.UInt64, "ExtendedTimeout",
1351
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1866
        type_func=lambda td: td.total_seconds() * 1000)
1352
1867
    interval = notifychangeproperty(
1353
1868
        dbus.UInt64, "Interval",
1354
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1869
        type_func=lambda td: td.total_seconds() * 1000)
1355
1870
    checker_command = notifychangeproperty(dbus.String, "Checker")
1356
1871
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1357
1872
                                  invalidate_only=True)
1358
 
    
 
1873
 
1359
1874
    del notifychangeproperty
1360
 
    
 
1875
 
1361
1876
    def __del__(self, *args, **kwargs):
1362
1877
        try:
1363
1878
            self.remove_from_connection()
1366
1881
        if hasattr(DBusObjectWithProperties, "__del__"):
1367
1882
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1368
1883
        Client.__del__(self, *args, **kwargs)
1369
 
    
 
1884
 
1370
1885
    def checker_callback(self, source, condition,
1371
1886
                         connection, command, *args, **kwargs):
1372
1887
        ret = Client.checker_callback(self, source, condition,
1376
1891
        if exitstatus >= 0:
1377
1892
            # Emit D-Bus signal
1378
1893
            self.CheckerCompleted(dbus.Int16(exitstatus),
1379
 
                                  dbus.Int64(0),
 
1894
                                  # This is specific to GNU libC
 
1895
                                  dbus.Int64(exitstatus << 8),
1380
1896
                                  dbus.String(command))
1381
1897
        else:
1382
1898
            # Emit D-Bus signal
1383
1899
            self.CheckerCompleted(dbus.Int16(-1),
1384
1900
                                  dbus.Int64(
1385
 
                                      self.last_checker_signal),
 
1901
                                      # This is specific to GNU libC
 
1902
                                      (exitstatus << 8)
 
1903
                                      | self.last_checker_signal),
1386
1904
                                  dbus.String(command))
1387
1905
        return ret
1388
 
    
 
1906
 
1389
1907
    def start_checker(self, *args, **kwargs):
1390
1908
        old_checker_pid = getattr(self.checker, "pid", None)
1391
1909
        r = Client.start_checker(self, *args, **kwargs)
1395
1913
            # Emit D-Bus signal
1396
1914
            self.CheckerStarted(self.current_checker_command)
1397
1915
        return r
1398
 
    
 
1916
 
1399
1917
    def _reset_approved(self):
1400
1918
        self.approved = None
1401
1919
        return False
1402
 
    
 
1920
 
1403
1921
    def approve(self, value=True):
1404
1922
        self.approved = value
1405
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
1406
 
                                * 1000), self._reset_approved)
 
1923
        GLib.timeout_add(int(self.approval_duration.total_seconds()
 
1924
                             * 1000), self._reset_approved)
1407
1925
        self.send_changedstate()
1408
 
    
1409
 
    ## D-Bus methods, signals & properties
1410
 
    
1411
 
    ## Interfaces
1412
 
    
1413
 
    ## Signals
1414
 
    
 
1926
 
 
1927
    #  D-Bus methods, signals & properties
 
1928
 
 
1929
    #  Interfaces
 
1930
 
 
1931
    #  Signals
 
1932
 
1415
1933
    # CheckerCompleted - signal
1416
1934
    @dbus.service.signal(_interface, signature="nxs")
1417
1935
    def CheckerCompleted(self, exitcode, waitstatus, command):
1418
1936
        "D-Bus signal"
1419
1937
        pass
1420
 
    
 
1938
 
1421
1939
    # CheckerStarted - signal
1422
1940
    @dbus.service.signal(_interface, signature="s")
1423
1941
    def CheckerStarted(self, command):
1424
1942
        "D-Bus signal"
1425
1943
        pass
1426
 
    
 
1944
 
1427
1945
    # PropertyChanged - signal
1428
1946
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1429
1947
    @dbus.service.signal(_interface, signature="sv")
1430
1948
    def PropertyChanged(self, property, value):
1431
1949
        "D-Bus signal"
1432
1950
        pass
1433
 
    
 
1951
 
1434
1952
    # GotSecret - signal
1435
1953
    @dbus.service.signal(_interface)
1436
1954
    def GotSecret(self):
1439
1957
        server to mandos-client
1440
1958
        """
1441
1959
        pass
1442
 
    
 
1960
 
1443
1961
    # Rejected - signal
1444
1962
    @dbus.service.signal(_interface, signature="s")
1445
1963
    def Rejected(self, reason):
1446
1964
        "D-Bus signal"
1447
1965
        pass
1448
 
    
 
1966
 
1449
1967
    # NeedApproval - signal
1450
1968
    @dbus.service.signal(_interface, signature="tb")
1451
1969
    def NeedApproval(self, timeout, default):
1452
1970
        "D-Bus signal"
1453
1971
        return self.need_approval()
1454
 
    
1455
 
    ## Methods
1456
 
    
 
1972
 
 
1973
    #  Methods
 
1974
 
1457
1975
    # Approve - method
1458
1976
    @dbus.service.method(_interface, in_signature="b")
1459
1977
    def Approve(self, value):
1460
1978
        self.approve(value)
1461
 
    
 
1979
 
1462
1980
    # CheckedOK - method
1463
1981
    @dbus.service.method(_interface)
1464
1982
    def CheckedOK(self):
1465
1983
        self.checked_ok()
1466
 
    
 
1984
 
1467
1985
    # Enable - method
 
1986
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1468
1987
    @dbus.service.method(_interface)
1469
1988
    def Enable(self):
1470
1989
        "D-Bus method"
1471
1990
        self.enable()
1472
 
    
 
1991
 
1473
1992
    # StartChecker - method
 
1993
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1474
1994
    @dbus.service.method(_interface)
1475
1995
    def StartChecker(self):
1476
1996
        "D-Bus method"
1477
1997
        self.start_checker()
1478
 
    
 
1998
 
1479
1999
    # Disable - method
 
2000
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1480
2001
    @dbus.service.method(_interface)
1481
2002
    def Disable(self):
1482
2003
        "D-Bus method"
1483
2004
        self.disable()
1484
 
    
 
2005
 
1485
2006
    # StopChecker - method
 
2007
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1486
2008
    @dbus.service.method(_interface)
1487
2009
    def StopChecker(self):
1488
2010
        self.stop_checker()
1489
 
    
1490
 
    ## Properties
1491
 
    
 
2011
 
 
2012
    #  Properties
 
2013
 
1492
2014
    # ApprovalPending - property
1493
2015
    @dbus_service_property(_interface, signature="b", access="read")
1494
2016
    def ApprovalPending_dbus_property(self):
1495
2017
        return dbus.Boolean(bool(self.approvals_pending))
1496
 
    
 
2018
 
1497
2019
    # ApprovedByDefault - property
1498
2020
    @dbus_service_property(_interface,
1499
2021
                           signature="b",
1502
2024
        if value is None:       # get
1503
2025
            return dbus.Boolean(self.approved_by_default)
1504
2026
        self.approved_by_default = bool(value)
1505
 
    
 
2027
 
1506
2028
    # ApprovalDelay - property
1507
2029
    @dbus_service_property(_interface,
1508
2030
                           signature="t",
1512
2034
            return dbus.UInt64(self.approval_delay.total_seconds()
1513
2035
                               * 1000)
1514
2036
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1515
 
    
 
2037
 
1516
2038
    # ApprovalDuration - property
1517
2039
    @dbus_service_property(_interface,
1518
2040
                           signature="t",
1522
2044
            return dbus.UInt64(self.approval_duration.total_seconds()
1523
2045
                               * 1000)
1524
2046
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1525
 
    
 
2047
 
1526
2048
    # Name - property
 
2049
    @dbus_annotations(
 
2050
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1527
2051
    @dbus_service_property(_interface, signature="s", access="read")
1528
2052
    def Name_dbus_property(self):
1529
2053
        return dbus.String(self.name)
1530
 
    
 
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
 
1531
2062
    # Fingerprint - property
 
2063
    @dbus_annotations(
 
2064
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1532
2065
    @dbus_service_property(_interface, signature="s", access="read")
1533
2066
    def Fingerprint_dbus_property(self):
1534
2067
        return dbus.String(self.fingerprint)
1535
 
    
 
2068
 
1536
2069
    # Host - property
1537
2070
    @dbus_service_property(_interface,
1538
2071
                           signature="s",
1541
2074
        if value is None:       # get
1542
2075
            return dbus.String(self.host)
1543
2076
        self.host = str(value)
1544
 
    
 
2077
 
1545
2078
    # Created - property
 
2079
    @dbus_annotations(
 
2080
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1546
2081
    @dbus_service_property(_interface, signature="s", access="read")
1547
2082
    def Created_dbus_property(self):
1548
2083
        return datetime_to_dbus(self.created)
1549
 
    
 
2084
 
1550
2085
    # LastEnabled - property
1551
2086
    @dbus_service_property(_interface, signature="s", access="read")
1552
2087
    def LastEnabled_dbus_property(self):
1553
2088
        return datetime_to_dbus(self.last_enabled)
1554
 
    
 
2089
 
1555
2090
    # Enabled - property
1556
2091
    @dbus_service_property(_interface,
1557
2092
                           signature="b",
1563
2098
            self.enable()
1564
2099
        else:
1565
2100
            self.disable()
1566
 
    
 
2101
 
1567
2102
    # LastCheckedOK - property
1568
2103
    @dbus_service_property(_interface,
1569
2104
                           signature="s",
1573
2108
            self.checked_ok()
1574
2109
            return
1575
2110
        return datetime_to_dbus(self.last_checked_ok)
1576
 
    
 
2111
 
1577
2112
    # LastCheckerStatus - property
1578
2113
    @dbus_service_property(_interface, signature="n", access="read")
1579
2114
    def LastCheckerStatus_dbus_property(self):
1580
2115
        return dbus.Int16(self.last_checker_status)
1581
 
    
 
2116
 
1582
2117
    # Expires - property
1583
2118
    @dbus_service_property(_interface, signature="s", access="read")
1584
2119
    def Expires_dbus_property(self):
1585
2120
        return datetime_to_dbus(self.expires)
1586
 
    
 
2121
 
1587
2122
    # LastApprovalRequest - property
1588
2123
    @dbus_service_property(_interface, signature="s", access="read")
1589
2124
    def LastApprovalRequest_dbus_property(self):
1590
2125
        return datetime_to_dbus(self.last_approval_request)
1591
 
    
 
2126
 
1592
2127
    # Timeout - property
1593
2128
    @dbus_service_property(_interface,
1594
2129
                           signature="t",
1609
2144
                if (getattr(self, "disable_initiator_tag", None)
1610
2145
                    is None):
1611
2146
                    return
1612
 
                gobject.source_remove(self.disable_initiator_tag)
1613
 
                self.disable_initiator_tag = gobject.timeout_add(
 
2147
                GLib.source_remove(self.disable_initiator_tag)
 
2148
                self.disable_initiator_tag = GLib.timeout_add(
1614
2149
                    int((self.expires - now).total_seconds() * 1000),
1615
2150
                    self.disable)
1616
 
    
 
2151
 
1617
2152
    # ExtendedTimeout - property
1618
2153
    @dbus_service_property(_interface,
1619
2154
                           signature="t",
1623
2158
            return dbus.UInt64(self.extended_timeout.total_seconds()
1624
2159
                               * 1000)
1625
2160
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1626
 
    
 
2161
 
1627
2162
    # Interval - property
1628
2163
    @dbus_service_property(_interface,
1629
2164
                           signature="t",
1636
2171
            return
1637
2172
        if self.enabled:
1638
2173
            # Reschedule checker run
1639
 
            gobject.source_remove(self.checker_initiator_tag)
1640
 
            self.checker_initiator_tag = gobject.timeout_add(
 
2174
            GLib.source_remove(self.checker_initiator_tag)
 
2175
            self.checker_initiator_tag = GLib.timeout_add(
1641
2176
                value, self.start_checker)
1642
 
            self.start_checker() # Start one now, too
1643
 
    
 
2177
            self.start_checker()  # Start one now, too
 
2178
 
1644
2179
    # Checker - property
1645
2180
    @dbus_service_property(_interface,
1646
2181
                           signature="s",
1649
2184
        if value is None:       # get
1650
2185
            return dbus.String(self.checker_command)
1651
2186
        self.checker_command = str(value)
1652
 
    
 
2187
 
1653
2188
    # CheckerRunning - property
1654
2189
    @dbus_service_property(_interface,
1655
2190
                           signature="b",
1661
2196
            self.start_checker()
1662
2197
        else:
1663
2198
            self.stop_checker()
1664
 
    
 
2199
 
1665
2200
    # ObjectPath - property
 
2201
    @dbus_annotations(
 
2202
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2203
         "org.freedesktop.DBus.Deprecated": "true"})
1666
2204
    @dbus_service_property(_interface, signature="o", access="read")
1667
2205
    def ObjectPath_dbus_property(self):
1668
 
        return self.dbus_object_path # is already a dbus.ObjectPath
1669
 
    
 
2206
        return self.dbus_object_path  # is already a dbus.ObjectPath
 
2207
 
1670
2208
    # Secret = property
 
2209
    @dbus_annotations(
 
2210
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2211
         "invalidates"})
1671
2212
    @dbus_service_property(_interface,
1672
2213
                           signature="ay",
1673
2214
                           access="write",
1674
2215
                           byte_arrays=True)
1675
2216
    def Secret_dbus_property(self, value):
1676
2217
        self.secret = bytes(value)
1677
 
    
 
2218
 
1678
2219
    del _interface
1679
2220
 
1680
2221
 
1681
2222
class ProxyClient(object):
1682
 
    def __init__(self, child_pipe, fpr, address):
 
2223
    def __init__(self, child_pipe, key_id, fpr, address):
1683
2224
        self._pipe = child_pipe
1684
 
        self._pipe.send(('init', fpr, address))
 
2225
        self._pipe.send(('init', key_id, fpr, address))
1685
2226
        if not self._pipe.recv():
1686
 
            raise KeyError(fpr)
1687
 
    
 
2227
            raise KeyError(key_id or fpr)
 
2228
 
1688
2229
    def __getattribute__(self, name):
1689
2230
        if name == '_pipe':
1690
2231
            return super(ProxyClient, self).__getattribute__(name)
1693
2234
        if data[0] == 'data':
1694
2235
            return data[1]
1695
2236
        if data[0] == 'function':
1696
 
            
 
2237
 
1697
2238
            def func(*args, **kwargs):
1698
2239
                self._pipe.send(('funcall', name, args, kwargs))
1699
2240
                return self._pipe.recv()[1]
1700
 
            
 
2241
 
1701
2242
            return func
1702
 
    
 
2243
 
1703
2244
    def __setattr__(self, name, value):
1704
2245
        if name == '_pipe':
1705
2246
            return super(ProxyClient, self).__setattr__(name, value)
1708
2249
 
1709
2250
class ClientHandler(socketserver.BaseRequestHandler, object):
1710
2251
    """A class to handle client connections.
1711
 
    
 
2252
 
1712
2253
    Instantiated once for each connection to handle it.
1713
2254
    Note: This will run in its own forked process."""
1714
 
    
 
2255
 
1715
2256
    def handle(self):
1716
2257
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1717
2258
            logger.info("TCP connection from: %s",
1718
2259
                        str(self.client_address))
1719
2260
            logger.debug("Pipe FD: %d",
1720
2261
                         self.server.child_pipe.fileno())
1721
 
            
1722
 
            session = gnutls.connection.ClientSession(
1723
 
                self.request, gnutls.connection .X509Credentials())
1724
 
            
1725
 
            # Note: gnutls.connection.X509Credentials is really a
1726
 
            # generic GnuTLS certificate credentials object so long as
1727
 
            # no X.509 keys are added to it.  Therefore, we can use it
1728
 
            # here despite using OpenPGP certificates.
1729
 
            
1730
 
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1731
 
            #                      "+AES-256-CBC", "+SHA1",
1732
 
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1733
 
            #                      "+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"))
1734
2269
            # Use a fallback default, since this MUST be set.
1735
2270
            priority = self.server.gnutls_priority
1736
2271
            if priority is None:
1737
2272
                priority = "NORMAL"
1738
 
            gnutls.library.functions.gnutls_priority_set_direct(
1739
 
                session._c_object, priority, None)
1740
 
            
 
2273
            gnutls.priority_set_direct(session._c_object,
 
2274
                                       priority.encode("utf-8"),
 
2275
                                       None)
 
2276
 
1741
2277
            # Start communication using the Mandos protocol
1742
2278
            # Get protocol number
1743
2279
            line = self.request.makefile().readline()
1748
2284
            except (ValueError, IndexError, RuntimeError) as error:
1749
2285
                logger.error("Unknown protocol version: %s", error)
1750
2286
                return
1751
 
            
 
2287
 
1752
2288
            # Start GnuTLS connection
1753
2289
            try:
1754
2290
                session.handshake()
1755
 
            except gnutls.errors.GNUTLSError as error:
 
2291
            except gnutls.Error as error:
1756
2292
                logger.warning("Handshake failed: %s", error)
1757
2293
                # Do not run session.bye() here: the session is not
1758
2294
                # established.  Just abandon the request.
1759
2295
                return
1760
2296
            logger.debug("Handshake succeeded")
1761
 
            
 
2297
 
1762
2298
            approval_required = False
1763
2299
            try:
1764
 
                try:
1765
 
                    fpr = self.fingerprint(
1766
 
                        self.peer_certificate(session))
1767
 
                except (TypeError,
1768
 
                        gnutls.errors.GNUTLSError) as error:
1769
 
                    logger.warning("Bad certificate: %s", error)
1770
 
                    return
1771
 
                logger.debug("Fingerprint: %s", fpr)
1772
 
                
1773
 
                try:
1774
 
                    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,
1775
2322
                                         self.client_address)
1776
2323
                except KeyError:
1777
2324
                    return
1778
 
                
 
2325
 
1779
2326
                if client.approval_delay:
1780
2327
                    delay = client.approval_delay
1781
2328
                    client.approvals_pending += 1
1782
2329
                    approval_required = True
1783
 
                
 
2330
 
1784
2331
                while True:
1785
2332
                    if not client.enabled:
1786
2333
                        logger.info("Client %s is disabled",
1789
2336
                            # Emit D-Bus signal
1790
2337
                            client.Rejected("Disabled")
1791
2338
                        return
1792
 
                    
 
2339
 
1793
2340
                    if client.approved or not client.approval_delay:
1794
 
                        #We are approved or approval is disabled
 
2341
                        # We are approved or approval is disabled
1795
2342
                        break
1796
2343
                    elif client.approved is None:
1797
2344
                        logger.info("Client %s needs approval",
1808
2355
                            # Emit D-Bus signal
1809
2356
                            client.Rejected("Denied")
1810
2357
                        return
1811
 
                    
1812
 
                    #wait until timeout or approved
 
2358
 
 
2359
                    # wait until timeout or approved
1813
2360
                    time = datetime.datetime.now()
1814
2361
                    client.changedstate.acquire()
1815
2362
                    client.changedstate.wait(delay.total_seconds())
1828
2375
                            break
1829
2376
                    else:
1830
2377
                        delay -= time2 - time
1831
 
                
1832
 
                sent_size = 0
1833
 
                while sent_size < len(client.secret):
1834
 
                    try:
1835
 
                        sent = session.send(client.secret[sent_size:])
1836
 
                    except gnutls.errors.GNUTLSError as error:
1837
 
                        logger.warning("gnutls send failed",
1838
 
                                       exc_info=error)
1839
 
                        return
1840
 
                    logger.debug("Sent: %d, remaining: %d", sent,
1841
 
                                 len(client.secret) - (sent_size
1842
 
                                                       + sent))
1843
 
                    sent_size += sent
1844
 
                
 
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
 
1845
2386
                logger.info("Sending secret to %s", client.name)
1846
2387
                # bump the timeout using extended_timeout
1847
2388
                client.bump_timeout(client.extended_timeout)
1848
2389
                if self.server.use_dbus:
1849
2390
                    # Emit D-Bus signal
1850
2391
                    client.GotSecret()
1851
 
            
 
2392
 
1852
2393
            finally:
1853
2394
                if approval_required:
1854
2395
                    client.approvals_pending -= 1
1855
2396
                try:
1856
2397
                    session.bye()
1857
 
                except gnutls.errors.GNUTLSError as error:
 
2398
                except gnutls.Error as error:
1858
2399
                    logger.warning("GnuTLS bye failed",
1859
2400
                                   exc_info=error)
1860
 
    
 
2401
 
1861
2402
    @staticmethod
1862
2403
    def peer_certificate(session):
1863
 
        "Return the peer's OpenPGP certificate as a bytestring"
1864
 
        # If not an OpenPGP certificate...
1865
 
        if (gnutls.library.functions.gnutls_certificate_type_get(
1866
 
                session._c_object)
1867
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1868
 
            # ...do the normal thing
1869
 
            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""
1870
2420
        list_size = ctypes.c_uint(1)
1871
 
        cert_list = (gnutls.library.functions
1872
 
                     .gnutls_certificate_get_peers
 
2421
        cert_list = (gnutls.certificate_get_peers
1873
2422
                     (session._c_object, ctypes.byref(list_size)))
1874
2423
        if not bool(cert_list) and list_size.value != 0:
1875
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1876
 
                                            " certificate")
 
2424
            raise gnutls.Error("error getting peer certificate")
1877
2425
        if list_size.value == 0:
1878
2426
            return None
1879
2427
        cert = cert_list[0]
1880
2428
        return ctypes.string_at(cert.data, cert.size)
1881
 
    
 
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
 
1882
2464
    @staticmethod
1883
2465
    def fingerprint(openpgp):
1884
2466
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1885
2467
        # New GnuTLS "datum" with the OpenPGP public key
1886
 
        datum = gnutls.library.types.gnutls_datum_t(
 
2468
        datum = gnutls.datum_t(
1887
2469
            ctypes.cast(ctypes.c_char_p(openpgp),
1888
2470
                        ctypes.POINTER(ctypes.c_ubyte)),
1889
2471
            ctypes.c_uint(len(openpgp)))
1890
2472
        # New empty GnuTLS certificate
1891
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1892
 
        gnutls.library.functions.gnutls_openpgp_crt_init(
1893
 
            ctypes.byref(crt))
 
2473
        crt = gnutls.openpgp_crt_t()
 
2474
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1894
2475
        # Import the OpenPGP public key into the certificate
1895
 
        gnutls.library.functions.gnutls_openpgp_crt_import(
1896
 
            crt, ctypes.byref(datum),
1897
 
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
2476
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2477
                                  gnutls.OPENPGP_FMT_RAW)
1898
2478
        # Verify the self signature in the key
1899
2479
        crtverify = ctypes.c_uint()
1900
 
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1901
 
            crt, 0, ctypes.byref(crtverify))
 
2480
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2481
                                       ctypes.byref(crtverify))
1902
2482
        if crtverify.value != 0:
1903
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1904
 
            raise gnutls.errors.CertificateSecurityError(
1905
 
                "Verify failed")
 
2483
            gnutls.openpgp_crt_deinit(crt)
 
2484
            raise gnutls.CertificateSecurityError(code
 
2485
                                                  =crtverify.value)
1906
2486
        # New buffer for the fingerprint
1907
2487
        buf = ctypes.create_string_buffer(20)
1908
2488
        buf_len = ctypes.c_size_t()
1909
2489
        # Get the fingerprint from the certificate into the buffer
1910
 
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1911
 
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
 
2490
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2491
                                           ctypes.byref(buf_len))
1912
2492
        # Deinit the certificate
1913
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2493
        gnutls.openpgp_crt_deinit(crt)
1914
2494
        # Convert the buffer to a Python bytestring
1915
2495
        fpr = ctypes.string_at(buf, buf_len.value)
1916
2496
        # Convert the bytestring to hexadecimal notation
1920
2500
 
1921
2501
class MultiprocessingMixIn(object):
1922
2502
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
1923
 
    
 
2503
 
1924
2504
    def sub_process_main(self, request, address):
1925
2505
        try:
1926
2506
            self.finish_request(request, address)
1927
2507
        except Exception:
1928
2508
            self.handle_error(request, address)
1929
2509
        self.close_request(request)
1930
 
    
 
2510
 
1931
2511
    def process_request(self, request, address):
1932
2512
        """Start a new process to process the request."""
1933
 
        proc = multiprocessing.Process(target = self.sub_process_main,
1934
 
                                       args = (request, address))
 
2513
        proc = multiprocessing.Process(target=self.sub_process_main,
 
2514
                                       args=(request, address))
1935
2515
        proc.start()
1936
2516
        return proc
1937
2517
 
1938
2518
 
1939
2519
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1940
2520
    """ adds a pipe to the MixIn """
1941
 
    
 
2521
 
1942
2522
    def process_request(self, request, client_address):
1943
2523
        """Overrides and wraps the original process_request().
1944
 
        
 
2524
 
1945
2525
        This function creates a new pipe in self.pipe
1946
2526
        """
1947
2527
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1948
 
        
 
2528
 
1949
2529
        proc = MultiprocessingMixIn.process_request(self, request,
1950
2530
                                                    client_address)
1951
2531
        self.child_pipe.close()
1952
2532
        self.add_pipe(parent_pipe, proc)
1953
 
    
 
2533
 
1954
2534
    def add_pipe(self, parent_pipe, proc):
1955
2535
        """Dummy function; override as necessary"""
1956
2536
        raise NotImplementedError()
1959
2539
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1960
2540
                     socketserver.TCPServer, object):
1961
2541
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1962
 
    
 
2542
 
1963
2543
    Attributes:
1964
2544
        enabled:        Boolean; whether this server is activated yet
1965
2545
        interface:      None or a network interface name (string)
1966
2546
        use_ipv6:       Boolean; to use IPv6 or not
1967
2547
    """
1968
 
    
 
2548
 
1969
2549
    def __init__(self, server_address, RequestHandlerClass,
1970
2550
                 interface=None,
1971
2551
                 use_ipv6=True,
1981
2561
            self.socketfd = socketfd
1982
2562
            # Save the original socket.socket() function
1983
2563
            self.socket_socket = socket.socket
 
2564
 
1984
2565
            # To implement --socket, we monkey patch socket.socket.
1985
 
            # 
 
2566
            #
1986
2567
            # (When socketserver.TCPServer is a new-style class, we
1987
2568
            # could make self.socket into a property instead of monkey
1988
2569
            # patching socket.socket.)
1989
 
            # 
 
2570
            #
1990
2571
            # Create a one-time-only replacement for socket.socket()
1991
2572
            @functools.wraps(socket.socket)
1992
2573
            def socket_wrapper(*args, **kwargs):
2004
2585
        # socket_wrapper(), if socketfd was set.
2005
2586
        socketserver.TCPServer.__init__(self, server_address,
2006
2587
                                        RequestHandlerClass)
2007
 
    
 
2588
 
2008
2589
    def server_bind(self):
2009
2590
        """This overrides the normal server_bind() function
2010
2591
        to bind to an interface if one was specified, and also NOT to
2011
2592
        bind to an address or port if they were not specified."""
 
2593
        global SO_BINDTODEVICE
2012
2594
        if self.interface is not None:
2013
2595
            if SO_BINDTODEVICE is None:
2014
 
                logger.error("SO_BINDTODEVICE does not exist;"
2015
 
                             " cannot bind to interface %s",
2016
 
                             self.interface)
2017
 
            else:
2018
 
                try:
2019
 
                    self.socket.setsockopt(
2020
 
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
2021
 
                        (self.interface + "\0").encode("utf-8"))
2022
 
                except socket.error as error:
2023
 
                    if error.errno == errno.EPERM:
2024
 
                        logger.error("No permission to bind to"
2025
 
                                     " interface %s", self.interface)
2026
 
                    elif error.errno == errno.ENOPROTOOPT:
2027
 
                        logger.error("SO_BINDTODEVICE not available;"
2028
 
                                     " cannot bind to interface %s",
2029
 
                                     self.interface)
2030
 
                    elif error.errno == errno.ENODEV:
2031
 
                        logger.error("Interface %s does not exist,"
2032
 
                                     " cannot bind", self.interface)
2033
 
                    else:
2034
 
                        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
2035
2617
        # Only bind(2) the socket if we really need to.
2036
2618
        if self.server_address[0] or self.server_address[1]:
2037
2619
            if not self.server_address[0]:
2038
2620
                if self.address_family == socket.AF_INET6:
2039
 
                    any_address = "::" # in6addr_any
 
2621
                    any_address = "::"  # in6addr_any
2040
2622
                else:
2041
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
2623
                    any_address = "0.0.0.0"  # INADDR_ANY
2042
2624
                self.server_address = (any_address,
2043
2625
                                       self.server_address[1])
2044
2626
            elif not self.server_address[1]:
2054
2636
 
2055
2637
class MandosServer(IPv6_TCPServer):
2056
2638
    """Mandos server.
2057
 
    
 
2639
 
2058
2640
    Attributes:
2059
2641
        clients:        set of Client objects
2060
2642
        gnutls_priority GnuTLS priority string
2061
2643
        use_dbus:       Boolean; to emit D-Bus signals or not
2062
 
    
2063
 
    Assumes a gobject.MainLoop event loop.
 
2644
 
 
2645
    Assumes a GLib.MainLoop event loop.
2064
2646
    """
2065
 
    
 
2647
 
2066
2648
    def __init__(self, server_address, RequestHandlerClass,
2067
2649
                 interface=None,
2068
2650
                 use_ipv6=True,
2078
2660
        self.gnutls_priority = gnutls_priority
2079
2661
        IPv6_TCPServer.__init__(self, server_address,
2080
2662
                                RequestHandlerClass,
2081
 
                                interface = interface,
2082
 
                                use_ipv6 = use_ipv6,
2083
 
                                socketfd = socketfd)
2084
 
    
 
2663
                                interface=interface,
 
2664
                                use_ipv6=use_ipv6,
 
2665
                                socketfd=socketfd)
 
2666
 
2085
2667
    def server_activate(self):
2086
2668
        if self.enabled:
2087
2669
            return socketserver.TCPServer.server_activate(self)
2088
 
    
 
2670
 
2089
2671
    def enable(self):
2090
2672
        self.enabled = True
2091
 
    
 
2673
 
2092
2674
    def add_pipe(self, parent_pipe, proc):
2093
2675
        # Call "handle_ipc" for both data and EOF events
2094
 
        gobject.io_add_watch(
 
2676
        GLib.io_add_watch(
2095
2677
            parent_pipe.fileno(),
2096
 
            gobject.IO_IN | gobject.IO_HUP,
 
2678
            GLib.IO_IN | GLib.IO_HUP,
2097
2679
            functools.partial(self.handle_ipc,
2098
 
                              parent_pipe = parent_pipe,
2099
 
                              proc = proc))
2100
 
    
 
2680
                              parent_pipe=parent_pipe,
 
2681
                              proc=proc))
 
2682
 
2101
2683
    def handle_ipc(self, source, condition,
2102
2684
                   parent_pipe=None,
2103
 
                   proc = None,
 
2685
                   proc=None,
2104
2686
                   client_object=None):
2105
2687
        # error, or the other end of multiprocessing.Pipe has closed
2106
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2688
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
2107
2689
            # Wait for other process to exit
2108
2690
            proc.join()
2109
2691
            return False
2110
 
        
 
2692
 
2111
2693
        # Read a request from the child
2112
2694
        request = parent_pipe.recv()
2113
2695
        command = request[0]
2114
 
        
 
2696
 
2115
2697
        if command == 'init':
2116
 
            fpr = request[1]
2117
 
            address = request[2]
2118
 
            
2119
 
            for c in self.clients.itervalues():
2120
 
                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:
2121
2707
                    client = c
2122
2708
                    break
2123
2709
            else:
2124
 
                logger.info("Client not found for fingerprint: %s, ad"
2125
 
                            "dress: %s", fpr, address)
 
2710
                logger.info("Client not found for key ID: %s, address"
 
2711
                            ": %s", key_id or fpr, address)
2126
2712
                if self.use_dbus:
2127
2713
                    # Emit D-Bus signal
2128
 
                    mandos_dbus_service.ClientNotFound(fpr,
 
2714
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2129
2715
                                                       address[0])
2130
2716
                parent_pipe.send(False)
2131
2717
                return False
2132
 
            
2133
 
            gobject.io_add_watch(
 
2718
 
 
2719
            GLib.io_add_watch(
2134
2720
                parent_pipe.fileno(),
2135
 
                gobject.IO_IN | gobject.IO_HUP,
 
2721
                GLib.IO_IN | GLib.IO_HUP,
2136
2722
                functools.partial(self.handle_ipc,
2137
 
                                  parent_pipe = parent_pipe,
2138
 
                                  proc = proc,
2139
 
                                  client_object = client))
 
2723
                                  parent_pipe=parent_pipe,
 
2724
                                  proc=proc,
 
2725
                                  client_object=client))
2140
2726
            parent_pipe.send(True)
2141
2727
            # remove the old hook in favor of the new above hook on
2142
2728
            # same fileno
2145
2731
            funcname = request[1]
2146
2732
            args = request[2]
2147
2733
            kwargs = request[3]
2148
 
            
 
2734
 
2149
2735
            parent_pipe.send(('data', getattr(client_object,
2150
2736
                                              funcname)(*args,
2151
2737
                                                        **kwargs)))
2152
 
        
 
2738
 
2153
2739
        if command == 'getattr':
2154
2740
            attrname = request[1]
2155
2741
            if isinstance(client_object.__getattribute__(attrname),
2158
2744
            else:
2159
2745
                parent_pipe.send((
2160
2746
                    'data', client_object.__getattribute__(attrname)))
2161
 
        
 
2747
 
2162
2748
        if command == 'setattr':
2163
2749
            attrname = request[1]
2164
2750
            value = request[2]
2165
2751
            setattr(client_object, attrname, value)
2166
 
        
 
2752
 
2167
2753
        return True
2168
2754
 
2169
2755
 
2170
2756
def rfc3339_duration_to_delta(duration):
2171
2757
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2172
 
    
 
2758
 
2173
2759
    >>> rfc3339_duration_to_delta("P7D")
2174
2760
    datetime.timedelta(7)
2175
2761
    >>> rfc3339_duration_to_delta("PT60S")
2185
2771
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2186
2772
    datetime.timedelta(1, 200)
2187
2773
    """
2188
 
    
 
2774
 
2189
2775
    # Parsing an RFC 3339 duration with regular expressions is not
2190
2776
    # possible - there would have to be multiple places for the same
2191
2777
    # values, like seconds.  The current code, while more esoteric, is
2192
2778
    # cleaner without depending on a parsing library.  If Python had a
2193
2779
    # built-in library for parsing we would use it, but we'd like to
2194
2780
    # avoid excessive use of external libraries.
2195
 
    
 
2781
 
2196
2782
    # New type for defining tokens, syntax, and semantics all-in-one
2197
2783
    Token = collections.namedtuple("Token", (
2198
2784
        "regexp",  # To match token; if "value" is not None, must have
2231
2817
                           frozenset((token_year, token_month,
2232
2818
                                      token_day, token_time,
2233
2819
                                      token_week)))
2234
 
    # Define starting values
2235
 
    value = datetime.timedelta() # Value so far
 
2820
    # Define starting values:
 
2821
    # Value so far
 
2822
    value = datetime.timedelta()
2236
2823
    found_token = None
2237
 
    followers = frozenset((token_duration, )) # Following valid tokens
2238
 
    s = duration                # String left to parse
 
2824
    # Following valid tokens
 
2825
    followers = frozenset((token_duration, ))
 
2826
    # String left to parse
 
2827
    s = duration
2239
2828
    # Loop until end token is found
2240
2829
    while found_token is not token_end:
2241
2830
        # Search for any currently valid tokens
2265
2854
 
2266
2855
def string_to_delta(interval):
2267
2856
    """Parse a string and return a datetime.timedelta
2268
 
    
 
2857
 
2269
2858
    >>> string_to_delta('7d')
2270
2859
    datetime.timedelta(7)
2271
2860
    >>> string_to_delta('60s')
2279
2868
    >>> string_to_delta('5m 30s')
2280
2869
    datetime.timedelta(0, 330)
2281
2870
    """
2282
 
    
 
2871
 
2283
2872
    try:
2284
2873
        return rfc3339_duration_to_delta(interval)
2285
2874
    except ValueError:
2286
2875
        pass
2287
 
    
 
2876
 
2288
2877
    timevalue = datetime.timedelta(0)
2289
2878
    for s in interval.split():
2290
2879
        try:
2308
2897
    return timevalue
2309
2898
 
2310
2899
 
2311
 
def daemon(nochdir = False, noclose = False):
 
2900
def daemon(nochdir=False, noclose=False):
2312
2901
    """See daemon(3).  Standard BSD Unix function.
2313
 
    
 
2902
 
2314
2903
    This should really exist as os.daemon, but it doesn't (yet)."""
2315
2904
    if os.fork():
2316
2905
        sys.exit()
2334
2923
 
2335
2924
 
2336
2925
def main():
2337
 
    
 
2926
 
2338
2927
    ##################################################################
2339
2928
    # Parsing of options, both command line and config file
2340
 
    
 
2929
 
2341
2930
    parser = argparse.ArgumentParser()
2342
2931
    parser.add_argument("-v", "--version", action="version",
2343
 
                        version = "%(prog)s {}".format(version),
 
2932
                        version="%(prog)s {}".format(version),
2344
2933
                        help="show version number and exit")
2345
2934
    parser.add_argument("-i", "--interface", metavar="IF",
2346
2935
                        help="Bind to interface IF")
2382
2971
    parser.add_argument("--no-zeroconf", action="store_false",
2383
2972
                        dest="zeroconf", help="Do not use Zeroconf",
2384
2973
                        default=None)
2385
 
    
 
2974
 
2386
2975
    options = parser.parse_args()
2387
 
    
 
2976
 
2388
2977
    if options.check:
2389
2978
        import doctest
2390
2979
        fail_count, test_count = doctest.testmod()
2391
2980
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2392
 
    
 
2981
 
2393
2982
    # Default values for config file for server-global settings
2394
 
    server_defaults = { "interface": "",
2395
 
                        "address": "",
2396
 
                        "port": "",
2397
 
                        "debug": "False",
2398
 
                        "priority":
2399
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2400
 
                        ":+SIGN-DSA-SHA256",
2401
 
                        "servicename": "Mandos",
2402
 
                        "use_dbus": "True",
2403
 
                        "use_ipv6": "True",
2404
 
                        "debuglevel": "",
2405
 
                        "restore": "True",
2406
 
                        "socket": "",
2407
 
                        "statedir": "/var/lib/mandos",
2408
 
                        "foreground": "False",
2409
 
                        "zeroconf": "True",
2410
 
                    }
2411
 
    
 
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
 
2412
3006
    # Parse config file for server-global settings
2413
3007
    server_config = configparser.SafeConfigParser(server_defaults)
2414
3008
    del server_defaults
2416
3010
    # Convert the SafeConfigParser object to a dict
2417
3011
    server_settings = server_config.defaults()
2418
3012
    # Use the appropriate methods on the non-string config options
2419
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
3013
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
3014
                   "foreground", "zeroconf"):
2420
3015
        server_settings[option] = server_config.getboolean("DEFAULT",
2421
3016
                                                           option)
2422
3017
    if server_settings["port"]:
2432
3027
            server_settings["socket"] = os.dup(server_settings
2433
3028
                                               ["socket"])
2434
3029
    del server_config
2435
 
    
 
3030
 
2436
3031
    # Override the settings from the config file with command line
2437
3032
    # options, if set.
2438
3033
    for option in ("interface", "address", "port", "debug",
2456
3051
    if server_settings["debug"]:
2457
3052
        server_settings["foreground"] = True
2458
3053
    # Now we have our good server settings in "server_settings"
2459
 
    
 
3054
 
2460
3055
    ##################################################################
2461
 
    
 
3056
 
2462
3057
    if (not server_settings["zeroconf"]
2463
3058
        and not (server_settings["port"]
2464
3059
                 or server_settings["socket"] != "")):
2465
3060
        parser.error("Needs port or socket to work without Zeroconf")
2466
 
    
 
3061
 
2467
3062
    # For convenience
2468
3063
    debug = server_settings["debug"]
2469
3064
    debuglevel = server_settings["debuglevel"]
2473
3068
                                     stored_state_file)
2474
3069
    foreground = server_settings["foreground"]
2475
3070
    zeroconf = server_settings["zeroconf"]
2476
 
    
 
3071
 
2477
3072
    if debug:
2478
3073
        initlogger(debug, logging.DEBUG)
2479
3074
    else:
2482
3077
        else:
2483
3078
            level = getattr(logging, debuglevel.upper())
2484
3079
            initlogger(debug, level)
2485
 
    
 
3080
 
2486
3081
    if server_settings["servicename"] != "Mandos":
2487
3082
        syslogger.setFormatter(
2488
3083
            logging.Formatter('Mandos ({}) [%(process)d]:'
2489
3084
                              ' %(levelname)s: %(message)s'.format(
2490
3085
                                  server_settings["servicename"])))
2491
 
    
 
3086
 
2492
3087
    # Parse config file with clients
2493
3088
    client_config = configparser.SafeConfigParser(Client
2494
3089
                                                  .client_defaults)
2495
3090
    client_config.read(os.path.join(server_settings["configdir"],
2496
3091
                                    "clients.conf"))
2497
 
    
 
3092
 
2498
3093
    global mandos_dbus_service
2499
3094
    mandos_dbus_service = None
2500
 
    
 
3095
 
2501
3096
    socketfd = None
2502
3097
    if server_settings["socket"] != "":
2503
3098
        socketfd = server_settings["socket"]
2519
3114
        except IOError as e:
2520
3115
            logger.error("Could not open file %r", pidfilename,
2521
3116
                         exc_info=e)
2522
 
    
2523
 
    for name in ("_mandos", "mandos", "nobody"):
 
3117
 
 
3118
    for name, group in (("_mandos", "_mandos"),
 
3119
                        ("mandos", "mandos"),
 
3120
                        ("nobody", "nogroup")):
2524
3121
        try:
2525
3122
            uid = pwd.getpwnam(name).pw_uid
2526
 
            gid = pwd.getpwnam(name).pw_gid
 
3123
            gid = pwd.getpwnam(group).pw_gid
2527
3124
            break
2528
3125
        except KeyError:
2529
3126
            continue
2533
3130
    try:
2534
3131
        os.setgid(gid)
2535
3132
        os.setuid(uid)
 
3133
        if debug:
 
3134
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3135
                                                             gid))
2536
3136
    except OSError as error:
 
3137
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3138
                       .format(uid, gid, os.strerror(error.errno)))
2537
3139
        if error.errno != errno.EPERM:
2538
3140
            raise
2539
 
    
 
3141
 
2540
3142
    if debug:
2541
3143
        # Enable all possible GnuTLS debugging
2542
 
        
 
3144
 
2543
3145
        # "Use a log level over 10 to enable all debugging options."
2544
3146
        # - GnuTLS manual
2545
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
2546
 
        
2547
 
        @gnutls.library.types.gnutls_log_func
 
3147
        gnutls.global_set_log_level(11)
 
3148
 
 
3149
        @gnutls.log_func
2548
3150
        def debug_gnutls(level, string):
2549
3151
            logger.debug("GnuTLS: %s", string[:-1])
2550
 
        
2551
 
        gnutls.library.functions.gnutls_global_set_log_function(
2552
 
            debug_gnutls)
2553
 
        
 
3152
 
 
3153
        gnutls.global_set_log_function(debug_gnutls)
 
3154
 
2554
3155
        # Redirect stdin so all checkers get /dev/null
2555
3156
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2556
3157
        os.dup2(null, sys.stdin.fileno())
2557
3158
        if null > 2:
2558
3159
            os.close(null)
2559
 
    
 
3160
 
2560
3161
    # Need to fork before connecting to D-Bus
2561
3162
    if not foreground:
2562
3163
        # Close all input and output, do double fork, etc.
2563
3164
        daemon()
2564
 
    
2565
 
    # multiprocessing will use threads, so before we use gobject we
2566
 
    # need to inform gobject that threads will be used.
2567
 
    gobject.threads_init()
2568
 
    
 
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
 
2569
3170
    global main_loop
2570
3171
    # From the Avahi example code
2571
3172
    DBusGMainLoop(set_as_default=True)
2572
 
    main_loop = gobject.MainLoop()
 
3173
    main_loop = GLib.MainLoop()
2573
3174
    bus = dbus.SystemBus()
2574
3175
    # End of Avahi example code
2575
3176
    if use_dbus:
2588
3189
    if zeroconf:
2589
3190
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2590
3191
        service = AvahiServiceToSyslog(
2591
 
            name = server_settings["servicename"],
2592
 
            servicetype = "_mandos._tcp",
2593
 
            protocol = protocol,
2594
 
            bus = bus)
 
3192
            name=server_settings["servicename"],
 
3193
            servicetype="_mandos._tcp",
 
3194
            protocol=protocol,
 
3195
            bus=bus)
2595
3196
        if server_settings["interface"]:
2596
3197
            service.interface = if_nametoindex(
2597
3198
                server_settings["interface"].encode("utf-8"))
2598
 
    
 
3199
 
2599
3200
    global multiprocessing_manager
2600
3201
    multiprocessing_manager = multiprocessing.Manager()
2601
 
    
 
3202
 
2602
3203
    client_class = Client
2603
3204
    if use_dbus:
2604
 
        client_class = functools.partial(ClientDBus, bus = bus)
2605
 
    
 
3205
        client_class = functools.partial(ClientDBus, bus=bus)
 
3206
 
2606
3207
    client_settings = Client.config_parser(client_config)
2607
3208
    old_client_settings = {}
2608
3209
    clients_data = {}
2609
 
    
 
3210
 
2610
3211
    # This is used to redirect stdout and stderr for checker processes
2611
3212
    global wnull
2612
 
    wnull = open(os.devnull, "w") # A writable /dev/null
 
3213
    wnull = open(os.devnull, "w")  # A writable /dev/null
2613
3214
    # Only used if server is running in foreground but not in debug
2614
3215
    # mode
2615
3216
    if debug or not foreground:
2616
3217
        wnull.close()
2617
 
    
 
3218
 
2618
3219
    # Get client data and settings from last running state.
2619
3220
    if server_settings["restore"]:
2620
3221
        try:
2621
3222
            with open(stored_state_path, "rb") as stored_state:
2622
 
                clients_data, old_client_settings = pickle.load(
2623
 
                    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"))
2624
3272
            os.remove(stored_state_path)
2625
3273
        except IOError as e:
2626
3274
            if e.errno == errno.ENOENT:
2634
3282
            logger.warning("Could not load persistent state: "
2635
3283
                           "EOFError:",
2636
3284
                           exc_info=e)
2637
 
    
 
3285
 
2638
3286
    with PGPEngine() as pgp:
2639
3287
        for client_name, client in clients_data.items():
2640
3288
            # Skip removed clients
2641
3289
            if client_name not in client_settings:
2642
3290
                continue
2643
 
            
 
3291
 
2644
3292
            # Decide which value to use after restoring saved state.
2645
3293
            # We have three different values: Old config file,
2646
3294
            # new config file, and saved state.
2657
3305
                        client[name] = value
2658
3306
                except KeyError:
2659
3307
                    pass
2660
 
            
 
3308
 
2661
3309
            # Clients who has passed its expire date can still be
2662
3310
            # enabled if its last checker was successful.  A Client
2663
3311
            # whose checker succeeded before we stored its state is
2696
3344
                    client_name))
2697
3345
                client["secret"] = (client_settings[client_name]
2698
3346
                                    ["secret"])
2699
 
    
 
3347
 
2700
3348
    # Add/remove clients based on new changes made to config
2701
3349
    for client_name in (set(old_client_settings)
2702
3350
                        - set(client_settings)):
2704
3352
    for client_name in (set(client_settings)
2705
3353
                        - set(old_client_settings)):
2706
3354
        clients_data[client_name] = client_settings[client_name]
2707
 
    
 
3355
 
2708
3356
    # Create all client objects
2709
3357
    for client_name, client in clients_data.items():
2710
3358
        tcp_server.clients[client_name] = client_class(
2711
 
            name = client_name,
2712
 
            settings = client,
2713
 
            server_settings = server_settings)
2714
 
    
 
3359
            name=client_name,
 
3360
            settings=client,
 
3361
            server_settings=server_settings)
 
3362
 
2715
3363
    if not tcp_server.clients:
2716
3364
        logger.warning("No clients defined")
2717
 
    
 
3365
 
2718
3366
    if not foreground:
2719
3367
        if pidfile is not None:
2720
3368
            pid = os.getpid()
2726
3374
                             pidfilename, pid)
2727
3375
        del pidfile
2728
3376
        del pidfilename
2729
 
    
2730
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2731
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2732
 
    
 
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
 
2733
3382
    if use_dbus:
2734
 
        
 
3383
 
2735
3384
        @alternate_dbus_interfaces(
2736
 
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2737
 
        class MandosDBusService(DBusObjectWithProperties):
 
3385
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
 
3386
        class MandosDBusService(DBusObjectWithObjectManager):
2738
3387
            """A D-Bus proxy object"""
2739
 
            
 
3388
 
2740
3389
            def __init__(self):
2741
3390
                dbus.service.Object.__init__(self, bus, "/")
2742
 
            
 
3391
 
2743
3392
            _interface = "se.recompile.Mandos"
2744
 
            
2745
 
            @dbus_interface_annotations(_interface)
2746
 
            def _foo(self):
2747
 
                return {
2748
 
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
2749
 
                    "false" }
2750
 
            
 
3393
 
2751
3394
            @dbus.service.signal(_interface, signature="o")
2752
3395
            def ClientAdded(self, objpath):
2753
3396
                "D-Bus signal"
2754
3397
                pass
2755
 
            
 
3398
 
2756
3399
            @dbus.service.signal(_interface, signature="ss")
2757
 
            def ClientNotFound(self, fingerprint, address):
 
3400
            def ClientNotFound(self, key_id, address):
2758
3401
                "D-Bus signal"
2759
3402
                pass
2760
 
            
 
3403
 
 
3404
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3405
                               "true"})
2761
3406
            @dbus.service.signal(_interface, signature="os")
2762
3407
            def ClientRemoved(self, objpath, name):
2763
3408
                "D-Bus signal"
2764
3409
                pass
2765
 
            
 
3410
 
 
3411
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3412
                               "true"})
2766
3413
            @dbus.service.method(_interface, out_signature="ao")
2767
3414
            def GetAllClients(self):
2768
3415
                "D-Bus method"
2769
3416
                return dbus.Array(c.dbus_object_path for c in
2770
 
                                  tcp_server.clients.itervalues())
2771
 
            
 
3417
                                  tcp_server.clients.values())
 
3418
 
 
3419
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3420
                               "true"})
2772
3421
            @dbus.service.method(_interface,
2773
3422
                                 out_signature="a{oa{sv}}")
2774
3423
            def GetAllClientsWithProperties(self):
2775
3424
                "D-Bus method"
2776
3425
                return dbus.Dictionary(
2777
 
                    { c.dbus_object_path: c.GetAll("")
2778
 
                      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()},
2779
3429
                    signature="oa{sv}")
2780
 
            
 
3430
 
2781
3431
            @dbus.service.method(_interface, in_signature="o")
2782
3432
            def RemoveClient(self, object_path):
2783
3433
                "D-Bus method"
2784
 
                for c in tcp_server.clients.itervalues():
 
3434
                for c in tcp_server.clients.values():
2785
3435
                    if c.dbus_object_path == object_path:
2786
3436
                        del tcp_server.clients[c.name]
2787
3437
                        c.remove_from_connection()
2788
 
                        # Don't signal anything except ClientRemoved
 
3438
                        # Don't signal the disabling
2789
3439
                        c.disable(quiet=True)
2790
 
                        # Emit D-Bus signal
2791
 
                        self.ClientRemoved(object_path, c.name)
 
3440
                        # Emit D-Bus signal for removal
 
3441
                        self.client_removed_signal(c)
2792
3442
                        return
2793
3443
                raise KeyError(object_path)
2794
 
            
 
3444
 
2795
3445
            del _interface
2796
 
        
 
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
 
2797
3483
        mandos_dbus_service = MandosDBusService()
2798
 
    
 
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
 
2799
3490
    def cleanup():
2800
3491
        "Cleanup function; run on exit"
2801
3492
        if zeroconf:
2802
3493
            service.cleanup()
2803
 
        
2804
 
        multiprocessing.active_children()
2805
 
        wnull.close()
 
3494
 
 
3495
        mp.active_children()
 
3496
        wn.close()
2806
3497
        if not (tcp_server.clients or client_settings):
2807
3498
            return
2808
 
        
 
3499
 
2809
3500
        # Store client before exiting. Secrets are encrypted with key
2810
3501
        # based on what config file has. If config file is
2811
3502
        # removed/edited, old secret will thus be unrecovable.
2812
3503
        clients = {}
2813
3504
        with PGPEngine() as pgp:
2814
 
            for client in tcp_server.clients.itervalues():
 
3505
            for client in tcp_server.clients.values():
2815
3506
                key = client_settings[client.name]["secret"]
2816
3507
                client.encrypted_secret = pgp.encrypt(client.secret,
2817
3508
                                                      key)
2818
3509
                client_dict = {}
2819
 
                
 
3510
 
2820
3511
                # A list of attributes that can not be pickled
2821
3512
                # + secret.
2822
 
                exclude = { "bus", "changedstate", "secret",
2823
 
                            "checker", "server_settings" }
 
3513
                exclude = {"bus", "changedstate", "secret",
 
3514
                           "checker", "server_settings"}
2824
3515
                for name, typ in inspect.getmembers(dbus.service
2825
3516
                                                    .Object):
2826
3517
                    exclude.add(name)
2827
 
                
 
3518
 
2828
3519
                client_dict["encrypted_secret"] = (client
2829
3520
                                                   .encrypted_secret)
2830
3521
                for attr in client.client_structure:
2831
3522
                    if attr not in exclude:
2832
3523
                        client_dict[attr] = getattr(client, attr)
2833
 
                
 
3524
 
2834
3525
                clients[client.name] = client_dict
2835
3526
                del client_settings[client.name]["secret"]
2836
 
        
 
3527
 
2837
3528
        try:
2838
3529
            with tempfile.NamedTemporaryFile(
2839
3530
                    mode='wb',
2841
3532
                    prefix='clients-',
2842
3533
                    dir=os.path.dirname(stored_state_path),
2843
3534
                    delete=False) as stored_state:
2844
 
                pickle.dump((clients, client_settings), stored_state)
 
3535
                pickle.dump((clients, client_settings), stored_state,
 
3536
                            protocol=2)
2845
3537
                tempname = stored_state.name
2846
3538
            os.rename(tempname, stored_state_path)
2847
3539
        except (IOError, OSError) as e:
2857
3549
                logger.warning("Could not save persistent state:",
2858
3550
                               exc_info=e)
2859
3551
                raise
2860
 
        
 
3552
 
2861
3553
        # Delete all clients, and settings from config
2862
3554
        while tcp_server.clients:
2863
3555
            name, client = tcp_server.clients.popitem()
2864
3556
            if use_dbus:
2865
3557
                client.remove_from_connection()
2866
 
            # Don't signal anything except ClientRemoved
 
3558
            # Don't signal the disabling
2867
3559
            client.disable(quiet=True)
 
3560
            # Emit D-Bus signal for removal
2868
3561
            if use_dbus:
2869
 
                # Emit D-Bus signal
2870
 
                mandos_dbus_service.ClientRemoved(
2871
 
                    client.dbus_object_path, client.name)
 
3562
                mandos_dbus_service.client_removed_signal(client)
2872
3563
        client_settings.clear()
2873
 
    
 
3564
 
2874
3565
    atexit.register(cleanup)
2875
 
    
2876
 
    for client in tcp_server.clients.itervalues():
 
3566
 
 
3567
    for client in tcp_server.clients.values():
2877
3568
        if use_dbus:
2878
 
            # Emit D-Bus signal
2879
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3569
            # Emit D-Bus signal for adding
 
3570
            mandos_dbus_service.client_added_signal(client)
2880
3571
        # Need to initiate checking of clients
2881
3572
        if client.enabled:
2882
3573
            client.init_checker()
2883
 
    
 
3574
 
2884
3575
    tcp_server.enable()
2885
3576
    tcp_server.server_activate()
2886
 
    
 
3577
 
2887
3578
    # Find out what port we got
2888
3579
    if zeroconf:
2889
3580
        service.port = tcp_server.socket.getsockname()[1]
2894
3585
    else:                       # IPv4
2895
3586
        logger.info("Now listening on address %r, port %d",
2896
3587
                    *tcp_server.socket.getsockname())
2897
 
    
2898
 
    #service.interface = tcp_server.socket.getsockname()[3]
2899
 
    
 
3588
 
 
3589
    # service.interface = tcp_server.socket.getsockname()[3]
 
3590
 
2900
3591
    try:
2901
3592
        if zeroconf:
2902
3593
            # From the Avahi example code
2907
3598
                cleanup()
2908
3599
                sys.exit(1)
2909
3600
            # End of Avahi example code
2910
 
        
2911
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2912
 
                             lambda *args, **kwargs:
2913
 
                             (tcp_server.handle_request
2914
 
                              (*args[2:], **kwargs) or True))
2915
 
        
 
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
 
2916
3607
        logger.debug("Starting main loop")
2917
3608
        main_loop.run()
2918
3609
    except AvahiError as error: