/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

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

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

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

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

Show diffs side-by-side

added added

removed removed

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