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