/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2024-09-08 17:40:26 UTC
  • Revision ID: teddy@recompile.se-20240908174026-yk98lyrpr0phsck1
Fix minor deprecated syntax issue in debian/control

The << syntax should be preferred to the deprecated < notation.

* debian/control (Source: mandos/Build-Depends): Change from having
  "systemd (< 256~rc2-1)" to "systemd (<< 256~rc2-1)".

Show diffs side-by-side

added added

removed removed

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