/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2024-11-03 15:32:05 UTC
  • mto: This revision was merged to the branch mainline in revision 412.
  • Revision ID: teddy@recompile.se-20241103153205-qota5ic1c4m2nqh4
Detect GPGME version correctly

It seems that newer versions of dpkg-query can print an empty version.
Change the code to also parse this output.

Reported-By: Pablo Abelenda <pabelenda@igalia.com>

Show diffs side-by-side

added added

removed removed

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