/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

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

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

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
# following functions: "AvahiService.add", "AvahiService.remove",
10
 
# "server_state_changed", "entry_group_state_changed", and some lines
11
 
# in "main".
12
 
# 
 
9
# methods "add", "remove", "server_state_changed",
 
10
# "entry_group_state_changed", "cleanup", and "activate" in the
 
11
# "AvahiService" class, and some lines in "main".
 
12
#
13
13
# Everything else is
14
 
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
15
 
# 
16
 
# This program is free software: you can redistribute it and/or modify
17
 
# 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
18
21
# the Free Software Foundation, either version 3 of the License, or
19
22
# (at your option) any later version.
20
23
#
21
 
#     This program is distributed in the hope that it will be useful,
22
 
#     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
23
26
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24
27
#     GNU General Public License for more details.
25
 
# 
 
28
#
26
29
# You should have received a copy of the GNU General Public License
27
 
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
28
 
# 
29
 
# Contact the authors at <mandos@fukt.bsnet.se>.
30
 
# 
31
 
 
32
 
from __future__ import division
33
 
 
34
 
import SocketServer
 
30
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
31
#
 
32
# Contact the authors at <mandos@recompile.se>.
 
33
#
 
34
from __future__ import (division, absolute_import, print_function,
 
35
                        unicode_literals)
 
36
 
 
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
35
51
import socket
36
 
import select
37
 
from optparse import OptionParser
38
52
import datetime
39
53
import errno
40
 
import gnutls.crypto
41
 
import gnutls.connection
42
 
import gnutls.errors
43
 
import gnutls.library.functions
44
 
import gnutls.library.constants
45
 
import gnutls.library.types
46
 
import ConfigParser
47
 
import sys
 
54
try:
 
55
    import ConfigParser as configparser
 
56
except ImportError:
 
57
    import configparser
48
58
import re
49
 
import os
50
59
import signal
51
 
from sets import Set
52
60
import subprocess
53
61
import atexit
54
62
import stat
55
 
import logging
56
63
import logging.handlers
 
64
import pwd
 
65
import contextlib
 
66
import struct
 
67
import fcntl
 
68
import functools
 
69
try:
 
70
    import cPickle as pickle
 
71
except ImportError:
 
72
    import pickle
 
73
import multiprocessing
 
74
import types
 
75
import binascii
 
76
import tempfile
 
77
import itertools
 
78
import collections
 
79
import codecs
 
80
import random
 
81
import shlex
57
82
 
58
83
import dbus
59
 
import gobject
60
 
import avahi
 
84
import dbus.service
 
85
import gi
 
86
from gi.repository import GLib
61
87
from dbus.mainloop.glib import DBusGMainLoop
62
88
import ctypes
63
 
 
64
 
# Brief description of the operation of this program:
65
 
# 
66
 
# This server announces itself as a Zeroconf service.  Connecting
67
 
# clients use the TLS protocol, with the unusual quirk that this
68
 
# server program acts as a TLS "client" while a connecting client acts
69
 
# as a TLS "server".  The client (acting as a TLS "server") must
70
 
# supply an OpenPGP certificate, and the fingerprint of this
71
 
# certificate is used by this server to look up (in a list read from a
72
 
# file at start time) which binary blob to give the client.  No other
73
 
# authentication or authorization is done by this server.
74
 
 
75
 
 
76
 
logger = logging.Logger('mandos')
77
 
syslogger = logging.handlers.SysLogHandler\
78
 
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON)
79
 
syslogger.setFormatter(logging.Formatter\
80
 
                        ('%(levelname)s: %(message)s'))
81
 
logger.addHandler(syslogger)
82
 
del syslogger
 
89
import ctypes.util
 
90
import xml.dom.minidom
 
91
import inspect
 
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:
 
122
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
 
123
except AttributeError:
 
124
    try:
 
125
        # This is where SO_BINDTODEVICE was up to and including Python
 
126
        # 2.6, and also 3.2:
 
127
        from IN import SO_BINDTODEVICE
 
128
    except ImportError:
 
129
        # In Python 2.7 it seems to have been removed entirely.
 
130
        # Try running the C preprocessor:
 
131
        try:
 
132
            cc = subprocess.Popen(["cc", "--language=c", "-E",
 
133
                                   "/dev/stdin"],
 
134
                                  stdin=subprocess.PIPE,
 
135
                                  stdout=subprocess.PIPE)
 
136
            stdout = cc.communicate(
 
137
                "#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
 
138
            SO_BINDTODEVICE = int(stdout.splitlines()[-1])
 
139
        except (OSError, ValueError, IndexError):
 
140
            # No value found
 
141
            SO_BINDTODEVICE = None
 
142
 
 
143
if sys.version_info < (3, 2):
 
144
    configparser.Configparser = configparser.SafeConfigParser
 
145
 
 
146
version = "1.8.17"
 
147
stored_state_file = "clients.pickle"
 
148
 
 
149
log = logging.getLogger(os.path.basename(sys.argv[0]))
 
150
logging.captureWarnings(True)   # Show warnings via the logging system
 
151
syslogger = None
 
152
 
 
153
try:
 
154
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
155
        ctypes.util.find_library("c")).if_nametoindex
 
156
except (OSError, AttributeError):
 
157
 
 
158
    def if_nametoindex(interface):
 
159
        "Get an interface index the hard way, i.e. using fcntl()"
 
160
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
161
        with contextlib.closing(socket.socket()) as s:
 
162
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
163
                                struct.pack(b"16s16x", interface))
 
164
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
165
        return interface_index
 
166
 
 
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
 
 
184
def initlogger(debug, level=logging.WARNING):
 
185
    """init logger and add loglevel"""
 
186
 
 
187
    global syslogger
 
188
    syslogger = (logging.handlers.SysLogHandler(
 
189
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
 
190
        address="/dev/log"))
 
191
    syslogger.setFormatter(logging.Formatter
 
192
                           ("Mandos [%(process)d]: %(levelname)s:"
 
193
                            " %(message)s"))
 
194
    log.addHandler(syslogger)
 
195
 
 
196
    if debug:
 
197
        console = logging.StreamHandler()
 
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)
 
204
 
 
205
 
 
206
class PGPError(Exception):
 
207
    """Exception if encryption/decryption fails"""
 
208
    pass
 
209
 
 
210
 
 
211
class PGPEngine:
 
212
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
213
 
 
214
    def __init__(self):
 
215
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
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
 
 
235
    def __enter__(self):
 
236
        return self
 
237
 
 
238
    def __exit__(self, exc_type, exc_value, traceback):
 
239
        self._cleanup()
 
240
        return False
 
241
 
 
242
    def __del__(self):
 
243
        self._cleanup()
 
244
 
 
245
    def _cleanup(self):
 
246
        if self.tempdir is not None:
 
247
            # Delete contents of tempdir
 
248
            for root, dirs, files in os.walk(self.tempdir,
 
249
                                             topdown=False):
 
250
                for filename in files:
 
251
                    os.remove(os.path.join(root, filename))
 
252
                for dirname in dirs:
 
253
                    os.rmdir(os.path.join(root, dirname))
 
254
            # Remove tempdir
 
255
            os.rmdir(self.tempdir)
 
256
            self.tempdir = None
 
257
 
 
258
    def password_encode(self, password):
 
259
        # Passphrase can not be empty and can not contain newlines or
 
260
        # NUL bytes.  So we prefix it and hex encode it.
 
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
 
 
269
    def encrypt(self, data, password):
 
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)
 
285
        return ciphertext
 
286
 
 
287
    def decrypt(self, data, password):
 
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)
 
303
        return decrypted_plaintext
 
304
 
 
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
83
330
 
84
331
 
85
332
class AvahiError(Exception):
86
 
    def __init__(self, value):
 
333
    def __init__(self, value, *args, **kwargs):
87
334
        self.value = value
88
 
    def __str__(self):
89
 
        return repr(self.value)
 
335
        return super(AvahiError, self).__init__(value, *args,
 
336
                                                **kwargs)
 
337
 
90
338
 
91
339
class AvahiServiceError(AvahiError):
92
340
    pass
93
341
 
 
342
 
94
343
class AvahiGroupError(AvahiError):
95
344
    pass
96
345
 
97
346
 
98
 
class AvahiService(object):
99
 
    """
 
347
class AvahiService:
 
348
    """An Avahi (Zeroconf) service.
 
349
 
 
350
    Attributes:
100
351
    interface: integer; avahi.IF_UNSPEC or an interface index.
101
352
               Used to optionally bind to the specified interface.
102
 
    name = string; Example: "Mandos"
103
 
    type = string; Example: "_mandos._tcp".
104
 
                   See <http://www.dns-sd.org/ServiceTypes.html>
105
 
    port = integer; what port to announce
106
 
    TXT = list of strings; TXT record for the service
107
 
    domain = string; Domain to publish on, default to .local if empty.
108
 
    host = string; Host to publish records for, default to localhost
109
 
                   if empty.
110
 
    max_renames = integer; maximum number of renames
111
 
    rename_count = integer; counter so we only rename after collisions
112
 
                   a sensible number of times
 
353
    name: string; Example: "Mandos"
 
354
    type: string; Example: "_mandos._tcp".
 
355
     See <https://www.iana.org/assignments/service-names-port-numbers>
 
356
    port: integer; what port to announce
 
357
    TXT: list of strings; TXT record for the service
 
358
    domain: string; Domain to publish on, default to .local if empty.
 
359
    host: string; Host to publish records for, default is localhost
 
360
    max_renames: integer; maximum number of renames
 
361
    rename_count: integer; counter so we only rename after collisions
 
362
                  a sensible number of times
 
363
    group: D-Bus Entry Group
 
364
    server: D-Bus Server
 
365
    bus: dbus.SystemBus()
113
366
    """
114
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
115
 
                 type = None, port = None, TXT = None, domain = "",
116
 
                 host = "", max_renames = 12):
117
 
        """An Avahi (Zeroconf) service. """
 
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):
118
379
        self.interface = interface
119
380
        self.name = name
120
 
        self.type = type
 
381
        self.type = servicetype
121
382
        self.port = port
122
 
        if TXT is None:
123
 
            self.TXT = []
124
 
        else:
125
 
            self.TXT = TXT
 
383
        self.TXT = TXT if TXT is not None else []
126
384
        self.domain = domain
127
385
        self.host = host
128
386
        self.rename_count = 0
129
 
    def rename(self):
 
387
        self.max_renames = max_renames
 
388
        self.protocol = protocol
 
389
        self.group = None       # our entry group
 
390
        self.server = None
 
391
        self.bus = bus
 
392
        self.entry_group_state_changed_match = None
 
393
 
 
394
    def rename(self, remove=True):
130
395
        """Derived from the Avahi example code"""
131
396
        if self.rename_count >= self.max_renames:
132
 
            logger.critical(u"No suitable service name found after %i"
133
 
                            u" retries, exiting.", rename_count)
 
397
            log.critical("No suitable Zeroconf service name found"
 
398
                         " after %i retries, exiting.",
 
399
                         self.rename_count)
134
400
            raise AvahiServiceError("Too many renames")
135
 
        name = server.GetAlternativeServiceName(name)
136
 
        logger.notice(u"Changing name to %r ...", name)
137
 
        self.remove()
138
 
        self.add()
 
401
        self.name = str(
 
402
            self.server.GetAlternativeServiceName(self.name))
139
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
 
140
420
    def remove(self):
141
421
        """Derived from the Avahi example code"""
142
 
        if group is not None:
143
 
            group.Reset()
 
422
        if self.entry_group_state_changed_match is not None:
 
423
            self.entry_group_state_changed_match.remove()
 
424
            self.entry_group_state_changed_match = None
 
425
        if self.group is not None:
 
426
            self.group.Reset()
 
427
 
144
428
    def add(self):
145
429
        """Derived from the Avahi example code"""
146
 
        global group
147
 
        if group is None:
148
 
            group = dbus.Interface\
149
 
                    (bus.get_object(avahi.DBUS_NAME,
150
 
                                    server.EntryGroupNew()),
151
 
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
152
 
            group.connect_to_signal('StateChanged',
153
 
                                    entry_group_state_changed)
154
 
        logger.debug(u"Adding service '%s' of type '%s' ...",
155
 
                     service.name, service.type)
156
 
        group.AddService(
157
 
                self.interface,         # interface
158
 
                avahi.PROTO_INET6,      # protocol
159
 
                dbus.UInt32(0),         # flags
160
 
                self.name, self.type,
161
 
                self.domain, self.host,
162
 
                dbus.UInt16(self.port),
163
 
                avahi.string_array_to_txt_array(self.TXT))
164
 
        group.Commit()
165
 
 
166
 
# From the Avahi example code:
167
 
group = None                            # our entry group
168
 
# End of Avahi example code
169
 
 
170
 
 
171
 
class Client(object):
 
430
        self.remove()
 
431
        if self.group is None:
 
432
            self.group = dbus.Interface(
 
433
                self.bus.get_object(avahi.DBUS_NAME,
 
434
                                    self.server.EntryGroupNew()),
 
435
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
436
        self.entry_group_state_changed_match = (
 
437
            self.group.connect_to_signal(
 
438
                "StateChanged", self.entry_group_state_changed))
 
439
        log.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
440
                  self.name, self.type)
 
441
        self.group.AddService(
 
442
            self.interface,
 
443
            self.protocol,
 
444
            dbus.UInt32(0),     # flags
 
445
            self.name, self.type,
 
446
            self.domain, self.host,
 
447
            dbus.UInt16(self.port),
 
448
            avahi.string_array_to_txt_array(self.TXT))
 
449
        self.group.Commit()
 
450
 
 
451
    def entry_group_state_changed(self, state, error):
 
452
        """Derived from the Avahi example code"""
 
453
        log.debug("Avahi entry group state change: %i", state)
 
454
 
 
455
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
456
            log.debug("Zeroconf service established.")
 
457
        elif state == avahi.ENTRY_GROUP_COLLISION:
 
458
            log.info("Zeroconf service name collision.")
 
459
            self.rename()
 
460
        elif state == avahi.ENTRY_GROUP_FAILURE:
 
461
            log.critical("Avahi: Error in group state changed %s",
 
462
                         str(error))
 
463
            raise AvahiGroupError("State changed: {!s}".format(error))
 
464
 
 
465
    def cleanup(self):
 
466
        """Derived from the Avahi example code"""
 
467
        if self.group is not None:
 
468
            try:
 
469
                self.group.Free()
 
470
            except (dbus.exceptions.UnknownMethodException,
 
471
                    dbus.exceptions.DBusException):
 
472
                pass
 
473
            self.group = None
 
474
        self.remove()
 
475
 
 
476
    def server_state_changed(self, state, error=None):
 
477
        """Derived from the Avahi example code"""
 
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
        }
 
485
        if state in bad_states:
 
486
            if bad_states[state] is not None:
 
487
                if error is None:
 
488
                    log.error(bad_states[state])
 
489
                else:
 
490
                    log.error(bad_states[state] + ": %r", error)
 
491
            self.cleanup()
 
492
        elif state == avahi.SERVER_RUNNING:
 
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)
 
504
        else:
 
505
            if error is None:
 
506
                log.debug("Unknown state: %r", state)
 
507
            else:
 
508
                log.debug("Unknown state: %r: %r", state, error)
 
509
 
 
510
    def activate(self):
 
511
        """Derived from the Avahi example code"""
 
512
        if self.server is None:
 
513
            self.server = dbus.Interface(
 
514
                self.bus.get_object(avahi.DBUS_NAME,
 
515
                                    avahi.DBUS_PATH_SERVER,
 
516
                                    follow_name_owner_changes=True),
 
517
                avahi.DBUS_INTERFACE_SERVER)
 
518
        self.server.connect_to_signal("StateChanged",
 
519
                                      self.server_state_changed)
 
520
        self.server_state_changed(self.server.GetState())
 
521
 
 
522
 
 
523
class AvahiServiceToSyslog(AvahiService):
 
524
    def rename(self, *args, **kwargs):
 
525
        """Add the new name to the syslog messages"""
 
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)))
 
531
        return ret
 
532
 
 
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:
172
875
    """A representation of a client host served by this server.
 
876
 
173
877
    Attributes:
174
 
    name:      string; from the config file, used in log messages
175
 
    fingerprint: string (40 or 32 hexadecimal digits); used to
176
 
                 uniquely identify the client
177
 
    secret:    bytestring; sent verbatim (over TLS) to client
178
 
    fqdn:      string (FQDN); available for use by the checker command
179
 
    created:   datetime.datetime(); object creation, not client host
180
 
    last_checked_ok: datetime.datetime() or None if not yet checked OK
181
 
    timeout:   datetime.timedelta(); How long from last_checked_ok
182
 
                                     until this client is invalid
183
 
    interval:  datetime.timedelta(); How often to start a new checker
184
 
    stop_hook: If set, called by stop() as stop_hook(self)
185
 
    checker:   subprocess.Popen(); a running checker process used
186
 
                                   to see if the client lives.
187
 
                                   'None' if no process is running.
188
 
    checker_initiator_tag: a gobject event source tag, or None
189
 
    stop_initiator_tag:    - '' -
190
 
    checker_callback_tag:  - '' -
191
 
    checker_command: string; External command which is run to check if
192
 
                     client lives.  %() expansions are done at
 
878
    approved:   bool(); None if not yet approved/disapproved
 
879
    approval_delay: datetime.timedelta(); Time to wait for approval
 
880
    approval_duration: datetime.timedelta(); Duration of one approval
 
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
 
885
    checker_command: string; External command which is run to check
 
886
                     if client lives.  %() expansions are done at
193
887
                     runtime with vars(self) as dict, so that for
194
888
                     instance %(name)s can be used in the command.
195
 
    Private attibutes:
196
 
    _timeout: Real variable for 'timeout'
197
 
    _interval: Real variable for 'interval'
198
 
    _timeout_milliseconds: Used when calling gobject.timeout_add()
199
 
    _interval_milliseconds: - '' -
 
889
    checker_initiator_tag: a GLib event source tag, or None
 
890
    created:    datetime.datetime(); (UTC) object creation
 
891
    client_structure: Object describing what attributes a client has
 
892
                      and is used for storing the client at exit
 
893
    current_checker_command: string; current running checker_command
 
894
    disable_initiator_tag: a GLib event source tag, or None
 
895
    enabled:    bool()
 
896
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
897
                 uniquely identify an OpenPGP client
 
898
    key_id: string (64 hexadecimal digits); used to uniquely identify
 
899
            a client using raw public keys
 
900
    host:       string; available for use by the checker command
 
901
    interval:   datetime.timedelta(); How often to start a new checker
 
902
    last_approval_request: datetime.datetime(); (UTC) or None
 
903
    last_checked_ok: datetime.datetime(); (UTC) or None
 
904
    last_checker_status: integer between 0 and 255 reflecting exit
 
905
                         status of last checker. -1 reflects crashed
 
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
 
909
    last_enabled: datetime.datetime(); (UTC) or None
 
910
    name:       string; from the config file, used in log messages and
 
911
                        D-Bus identifiers
 
912
    secret:     bytestring; sent verbatim (over TLS) to client
 
913
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
914
                                      until this client is disabled
 
915
    extended_timeout:   extra long timeout when secret has been sent
 
916
    runtime_expansions: Allowed attributes for runtime expansion.
 
917
    expires:    datetime.datetime(); time (UTC) when a client will be
 
918
                disabled, or None
 
919
    server_settings: The server_settings dict from main()
200
920
    """
201
 
    def _set_timeout(self, timeout):
202
 
        "Setter function for 'timeout' attribute"
203
 
        self._timeout = timeout
204
 
        self._timeout_milliseconds = ((self.timeout.days
205
 
                                       * 24 * 60 * 60 * 1000)
206
 
                                      + (self.timeout.seconds * 1000)
207
 
                                      + (self.timeout.microseconds
208
 
                                         // 1000))
209
 
    timeout = property(lambda self: self._timeout,
210
 
                       _set_timeout)
211
 
    del _set_timeout
212
 
    def _set_interval(self, interval):
213
 
        "Setter function for 'interval' attribute"
214
 
        self._interval = interval
215
 
        self._interval_milliseconds = ((self.interval.days
216
 
                                        * 24 * 60 * 60 * 1000)
217
 
                                       + (self.interval.seconds
218
 
                                          * 1000)
219
 
                                       + (self.interval.microseconds
220
 
                                          // 1000))
221
 
    interval = property(lambda self: self._interval,
222
 
                        _set_interval)
223
 
    del _set_interval
224
 
    def __init__(self, name=None, stop_hook=None, fingerprint=None,
225
 
                 secret=None, secfile=None, fqdn=None, timeout=None,
226
 
                 interval=-1, checker=None):
227
 
        """Note: the 'checker' argument sets the 'checker_command'
228
 
        attribute and not the 'checker' attribute.."""
 
921
 
 
922
    runtime_expansions = ("approval_delay", "approval_duration",
 
923
                          "created", "enabled", "expires", "key_id",
 
924
                          "fingerprint", "host", "interval",
 
925
                          "last_approval_request", "last_checked_ok",
 
926
                          "last_enabled", "name", "timeout")
 
927
    client_defaults = {
 
928
        "timeout": "PT5M",
 
929
        "extended_timeout": "PT15M",
 
930
        "interval": "PT2M",
 
931
        "checker": "fping -q -- %%(host)s",
 
932
        "host": "",
 
933
        "approval_delay": "PT0S",
 
934
        "approval_duration": "PT1S",
 
935
        "approved_by_default": "True",
 
936
        "enabled": "True",
 
937
    }
 
938
 
 
939
    @staticmethod
 
940
    def config_parser(config):
 
941
        """Construct a new dict of client settings of this form:
 
942
        { client_name: {setting_name: value, ...}, ...}
 
943
        with exceptions for any special settings as defined above.
 
944
        NOTE: Must be a pure function. Must return the same result
 
945
        value given the same arguments.
 
946
        """
 
947
        settings = {}
 
948
        for client_name in config.sections():
 
949
            section = dict(config.items(client_name))
 
950
            client = settings[client_name] = {}
 
951
 
 
952
            client["host"] = section["host"]
 
953
            # Reformat values from string types to Python types
 
954
            client["approved_by_default"] = config.getboolean(
 
955
                client_name, "approved_by_default")
 
956
            client["enabled"] = config.getboolean(client_name,
 
957
                                                  "enabled")
 
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()
 
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
 
972
            if "secret" in section:
 
973
                client["secret"] = codecs.decode(section["secret"]
 
974
                                                 .encode("utf-8"),
 
975
                                                 "base64")
 
976
            elif "secfile" in section:
 
977
                with open(os.path.expanduser(os.path.expandvars
 
978
                                             (section["secfile"])),
 
979
                          "rb") as secfile:
 
980
                    client["secret"] = secfile.read()
 
981
            else:
 
982
                raise TypeError("No secret or secfile for section {}"
 
983
                                .format(section))
 
984
            client["timeout"] = string_to_delta(section["timeout"])
 
985
            client["extended_timeout"] = string_to_delta(
 
986
                section["extended_timeout"])
 
987
            client["interval"] = string_to_delta(section["interval"])
 
988
            client["approval_delay"] = string_to_delta(
 
989
                section["approval_delay"])
 
990
            client["approval_duration"] = string_to_delta(
 
991
                section["approval_duration"])
 
992
            client["checker_command"] = section["checker"]
 
993
            client["last_approval_request"] = None
 
994
            client["last_checked_ok"] = None
 
995
            client["last_checker_status"] = -2
 
996
 
 
997
        return settings
 
998
 
 
999
    def __init__(self, settings, name=None, server_settings=None):
229
1000
        self.name = name
230
 
        logger.debug(u"Creating client %r", self.name)
231
 
        # Uppercase and remove spaces from fingerprint
232
 
        # for later comparison purposes with return value of
233
 
        # the fingerprint() function
234
 
        self.fingerprint = fingerprint.upper().replace(u" ", u"")
235
 
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
236
 
        if secret:
237
 
            self.secret = secret.decode(u"base64")
238
 
        elif secfile:
239
 
            sf = open(secfile)
240
 
            self.secret = sf.read()
241
 
            sf.close()
 
1001
        if server_settings is None:
 
1002
            server_settings = {}
 
1003
        self.server_settings = server_settings
 
1004
        # adding all client settings
 
1005
        for setting, value in settings.items():
 
1006
            setattr(self, setting, value)
 
1007
 
 
1008
        if self.enabled:
 
1009
            if not hasattr(self, "last_enabled"):
 
1010
                self.last_enabled = datetime.datetime.utcnow()
 
1011
            if not hasattr(self, "expires"):
 
1012
                self.expires = (datetime.datetime.utcnow()
 
1013
                                + self.timeout)
242
1014
        else:
243
 
            raise TypeError(u"No secret or secfile for client %s"
244
 
                            % self.name)
245
 
        self.fqdn = fqdn
246
 
        self.created = datetime.datetime.now()
247
 
        self.last_checked_ok = None
248
 
        self.timeout = string_to_delta(timeout)
249
 
        self.interval = string_to_delta(interval)
250
 
        self.stop_hook = stop_hook
 
1015
            self.last_enabled = None
 
1016
            self.expires = None
 
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)
 
1021
        self.created = settings.get("created",
 
1022
                                    datetime.datetime.utcnow())
 
1023
 
 
1024
        # attributes specific for this server instance
251
1025
        self.checker = None
252
1026
        self.checker_initiator_tag = None
253
 
        self.stop_initiator_tag = None
 
1027
        self.disable_initiator_tag = None
254
1028
        self.checker_callback_tag = None
255
 
        self.check_command = checker
256
 
    def start(self):
 
1029
        self.current_checker_command = None
 
1030
        self.approved = None
 
1031
        self.approvals_pending = 0
 
1032
        self.changedstate = multiprocessing_manager.Condition(
 
1033
            multiprocessing_manager.Lock())
 
1034
        self.client_structure = [attr
 
1035
                                 for attr in self.__dict__.keys()
 
1036
                                 if not attr.startswith("_")]
 
1037
        self.client_structure.append("client_structure")
 
1038
 
 
1039
        for name, t in inspect.getmembers(
 
1040
                type(self), lambda obj: isinstance(obj, property)):
 
1041
            if not name.startswith("_"):
 
1042
                self.client_structure.append(name)
 
1043
 
 
1044
    # Send notice to process children that client state has changed
 
1045
    def send_changedstate(self):
 
1046
        with self.changedstate:
 
1047
            self.changedstate.notify_all()
 
1048
 
 
1049
    def enable(self):
257
1050
        """Start this client's checker and timeout hooks"""
258
 
        # Schedule a new checker to be started an 'interval' from now,
259
 
        # and every interval from then on.
260
 
        self.checker_initiator_tag = gobject.timeout_add\
261
 
                                     (self._interval_milliseconds,
262
 
                                      self.start_checker)
263
 
        # Also start a new checker *right now*.
264
 
        self.start_checker()
265
 
        # Schedule a stop() when 'timeout' has passed
266
 
        self.stop_initiator_tag = gobject.timeout_add\
267
 
                                  (self._timeout_milliseconds,
268
 
                                   self.stop)
269
 
    def stop(self):
270
 
        """Stop this client.
271
 
        The possibility that a client might be restarted is left open,
272
 
        but not currently used."""
273
 
        # If this client doesn't have a secret, it is already stopped.
274
 
        if self.secret:
275
 
            logger.debug(u"Stopping client %s", self.name)
276
 
            self.secret = None
277
 
        else:
 
1051
        if getattr(self, "enabled", False):
 
1052
            # Already enabled
 
1053
            return
 
1054
        self.enabled = True
 
1055
        self.last_enabled = datetime.datetime.utcnow()
 
1056
        self.init_checker()
 
1057
        self.send_changedstate()
 
1058
 
 
1059
    def disable(self, quiet=True):
 
1060
        """Disable this client."""
 
1061
        if not getattr(self, "enabled", False):
278
1062
            return False
279
 
        if getattr(self, "stop_initiator_tag", False):
280
 
            gobject.source_remove(self.stop_initiator_tag)
281
 
            self.stop_initiator_tag = None
282
 
        if getattr(self, "checker_initiator_tag", False):
283
 
            gobject.source_remove(self.checker_initiator_tag)
 
1063
        if not quiet:
 
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)
 
1067
            self.disable_initiator_tag = None
 
1068
        self.expires = None
 
1069
        if getattr(self, "checker_initiator_tag", None) is not None:
 
1070
            GLib.source_remove(self.checker_initiator_tag)
284
1071
            self.checker_initiator_tag = None
285
1072
        self.stop_checker()
286
 
        if self.stop_hook:
287
 
            self.stop_hook(self)
288
 
        # Do not run this again if called by a gobject.timeout_add
 
1073
        self.enabled = False
 
1074
        if not quiet:
 
1075
            self.send_changedstate()
 
1076
        # Do not run this again if called by a GLib.timeout_add
289
1077
        return False
 
1078
 
290
1079
    def __del__(self):
291
 
        self.stop_hook = None
292
 
        self.stop()
293
 
    def checker_callback(self, pid, condition):
 
1080
        self.disable()
 
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):
294
1114
        """The checker has completed, so take appropriate actions."""
295
 
        now = datetime.datetime.now()
 
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()
296
1120
        self.checker_callback_tag = None
297
1121
        self.checker = None
298
 
        if os.WIFEXITED(condition) \
299
 
               and (os.WEXITSTATUS(condition) == 0):
300
 
            logger.debug(u"Checker for %(name)s succeeded",
301
 
                         vars(self))
302
 
            self.last_checked_ok = now
303
 
            gobject.source_remove(self.stop_initiator_tag)
304
 
            self.stop_initiator_tag = gobject.timeout_add\
305
 
                                      (self._timeout_milliseconds,
306
 
                                       self.stop)
307
 
        elif not os.WIFEXITED(condition):
308
 
            logger.warning(u"Checker for %(name)s crashed?",
309
 
                           vars(self))
 
1122
 
 
1123
        if returncode >= 0:
 
1124
            self.last_checker_status = returncode
 
1125
            self.last_checker_signal = None
 
1126
            if self.last_checker_status == 0:
 
1127
                log.info("Checker for %(name)s succeeded", vars(self))
 
1128
                self.checked_ok()
 
1129
            else:
 
1130
                log.info("Checker for %(name)s failed", vars(self))
310
1131
        else:
311
 
            logger.debug(u"Checker for %(name)s failed",
312
 
                         vars(self))
313
 
    def start_checker(self):
 
1132
            self.last_checker_status = -1
 
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."""
 
1146
        if timeout is None:
 
1147
            timeout = self.timeout
 
1148
        if self.disable_initiator_tag is not None:
 
1149
            GLib.source_remove(self.disable_initiator_tag)
 
1150
            self.disable_initiator_tag = None
 
1151
        if getattr(self, "enabled", False):
 
1152
            self.disable_initiator_tag = GLib.timeout_add(
 
1153
                int(timeout.total_seconds() * 1000), self.disable)
 
1154
            self.expires = datetime.datetime.utcnow() + timeout
 
1155
 
 
1156
    def need_approval(self):
 
1157
        self.last_approval_request = datetime.datetime.utcnow()
 
1158
 
 
1159
    def start_checker(self, start_was_randomized=False):
314
1160
        """Start a new checker subprocess if one is not running.
 
1161
 
315
1162
        If a checker already exists, leave it running and do
316
1163
        nothing."""
317
1164
        # The reason for not killing a running checker is that if we
318
 
        # did that, then if a checker (for some reason) started
319
 
        # running slowly and taking more than 'interval' time, the
320
 
        # client would inevitably timeout, since no checker would get
321
 
        # 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
322
1169
        # checkers alone, the checker would have to take more time
323
 
        # than 'timeout' for the client to be declared invalid, which
324
 
        # is as it should be.
 
1170
        # than 'timeout' for the client to be disabled, which is as it
 
1171
        # should be.
 
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
 
1177
        # Start a new checker if needed
325
1178
        if self.checker is None:
326
 
            try:
327
 
                # In case check_command has exactly one % operator
328
 
                command = self.check_command % self.fqdn
329
 
            except TypeError:
330
 
                # Escape attributes for the shell
331
 
                escaped_attrs = dict((key, re.escape(str(val)))
332
 
                                     for key, val in
333
 
                                     vars(self).iteritems())
334
 
                try:
335
 
                    command = self.check_command % escaped_attrs
336
 
                except TypeError, error:
337
 
                    logger.error(u'Could not format string "%s":'
338
 
                                 u' %s', self.check_command, error)
339
 
                    return True # Try again later
340
 
            try:
341
 
                logger.debug(u"Starting checker %r for %s",
342
 
                             command, self.name)
343
 
                self.checker = subprocess.Popen(command,
344
 
                                                close_fds=True,
345
 
                                                shell=True, cwd="/")
346
 
                self.checker_callback_tag = gobject.child_watch_add\
347
 
                                            (self.checker.pid,
348
 
                                             self.checker_callback)
349
 
            except subprocess.OSError, error:
350
 
                logger.error(u"Failed to start subprocess: %s",
351
 
                             error)
352
 
        # Re-run this periodically if run by gobject.timeout_add
 
1179
            # Escape attributes for the shell
 
1180
            escaped_attrs = {
 
1181
                attr: shlex.quote(str(getattr(self, attr)))
 
1182
                for attr in self.runtime_expansions}
 
1183
            try:
 
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
 
1189
            self.current_checker_command = command
 
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
353
1227
        return True
 
1228
 
354
1229
    def stop_checker(self):
355
1230
        """Force the checker process, if any, to stop."""
356
1231
        if self.checker_callback_tag:
357
 
            gobject.source_remove(self.checker_callback_tag)
 
1232
            GLib.source_remove(self.checker_callback_tag)
358
1233
            self.checker_callback_tag = None
359
1234
        if getattr(self, "checker", None) is None:
360
1235
            return
361
 
        logger.debug("Stopping checker for %(name)s", vars(self))
362
 
        try:
363
 
            os.kill(self.checker.pid, signal.SIGTERM)
364
 
            #os.sleep(0.5)
365
 
            #if self.checker.poll() is None:
366
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
367
 
        except OSError, error:
368
 
            if error.errno != errno.ESRCH: # No such process
369
 
                raise
 
1236
        log.debug("Stopping checker for %(name)s", vars(self))
 
1237
        self.checker.terminate()
370
1238
        self.checker = None
371
 
    def still_valid(self):
372
 
        """Has the timeout not yet passed for this client?"""
373
 
        now = datetime.datetime.now()
374
 
        if self.last_checked_ok is None:
375
 
            return now < (self.created + self.timeout)
376
 
        else:
377
 
            return now < (self.last_checked_ok + self.timeout)
378
 
 
379
 
 
380
 
def peer_certificate(session):
381
 
    "Return the peer's OpenPGP certificate as a bytestring"
382
 
    # If not an OpenPGP certificate...
383
 
    if gnutls.library.functions.gnutls_certificate_type_get\
384
 
            (session._c_object) \
385
 
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
386
 
        # ...do the normal thing
387
 
        return session.peer_certificate
388
 
    list_size = ctypes.c_uint()
389
 
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
390
 
        (session._c_object, ctypes.byref(list_size))
391
 
    if list_size.value == 0:
392
 
        return None
393
 
    cert = cert_list[0]
394
 
    return ctypes.string_at(cert.data, cert.size)
395
 
 
396
 
 
397
 
def fingerprint(openpgp):
398
 
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
399
 
    # New empty GnuTLS certificate
400
 
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
401
 
    gnutls.library.functions.gnutls_openpgp_crt_init\
402
 
        (ctypes.byref(crt))
403
 
    # New GnuTLS "datum" with the OpenPGP public key
404
 
    datum = gnutls.library.types.gnutls_datum_t\
405
 
        (ctypes.cast(ctypes.c_char_p(openpgp),
406
 
                     ctypes.POINTER(ctypes.c_ubyte)),
407
 
         ctypes.c_uint(len(openpgp)))
408
 
    # Import the OpenPGP public key into the certificate
409
 
    ret = gnutls.library.functions.gnutls_openpgp_crt_import\
410
 
        (crt,
411
 
         ctypes.byref(datum),
412
 
         gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
413
 
    # New buffer for the fingerprint
414
 
    buffer = ctypes.create_string_buffer(20)
415
 
    buffer_length = ctypes.c_size_t()
416
 
    # Get the fingerprint from the certificate into the buffer
417
 
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
418
 
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
419
 
    # Deinit the certificate
420
 
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
421
 
    # Convert the buffer to a Python bytestring
422
 
    fpr = ctypes.string_at(buffer, buffer_length.value)
423
 
    # Convert the bytestring to hexadecimal notation
424
 
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
425
 
    return hex_fpr
426
 
 
427
 
 
428
 
class tcp_handler(SocketServer.BaseRequestHandler, object):
429
 
    """A TCP request handler class.
430
 
    Instantiated by IPv6_TCPServer for each request to handle it.
 
1239
 
 
1240
 
 
1241
def dbus_service_property(dbus_interface,
 
1242
                          signature="v",
 
1243
                          access="readwrite",
 
1244
                          byte_arrays=False):
 
1245
    """Decorators for marking methods of a DBusObjectWithProperties to
 
1246
    become properties on the D-Bus.
 
1247
 
 
1248
    The decorated method will be called with no arguments by "Get"
 
1249
    and with one argument by "Set".
 
1250
 
 
1251
    The parameters, where they are supported, are the same as
 
1252
    dbus.service.method, except there is only "signature", since the
 
1253
    type from Get() and the type sent to Set() is the same.
 
1254
    """
 
1255
    # Encoding deeply encoded byte arrays is not supported yet by the
 
1256
    # "Set" method, so we fail early here:
 
1257
    if byte_arrays and signature != "ay":
 
1258
        raise ValueError("Byte arrays not supported for non-'ay'"
 
1259
                         " signature {!r}".format(signature))
 
1260
 
 
1261
    def decorator(func):
 
1262
        func._dbus_is_property = True
 
1263
        func._dbus_interface = dbus_interface
 
1264
        func._dbus_signature = signature
 
1265
        func._dbus_access = access
 
1266
        func._dbus_name = func.__name__
 
1267
        if func._dbus_name.endswith("_dbus_property"):
 
1268
            func._dbus_name = func._dbus_name[:-14]
 
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
 
 
1315
    return decorator
 
1316
 
 
1317
 
 
1318
class DBusPropertyException(dbus.exceptions.DBusException):
 
1319
    """A base class for D-Bus property-related exceptions
 
1320
    """
 
1321
    pass
 
1322
 
 
1323
 
 
1324
class DBusPropertyAccessException(DBusPropertyException):
 
1325
    """A property's access permissions disallows an operation.
 
1326
    """
 
1327
    pass
 
1328
 
 
1329
 
 
1330
class DBusPropertyNotFound(DBusPropertyException):
 
1331
    """An attempt was made to access a non-existing property.
 
1332
    """
 
1333
    pass
 
1334
 
 
1335
 
 
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):
 
1426
    """A D-Bus object with properties.
 
1427
 
 
1428
    Classes inheriting from this can use the dbus_service_property
 
1429
    decorator to expose methods as D-Bus properties.  It exposes the
 
1430
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1431
    """
 
1432
 
 
1433
    def _get_dbus_property(self, interface_name, property_name):
 
1434
        """Returns a bound method if one exists which is a D-Bus
 
1435
        property with the specified name and interface.
 
1436
        """
 
1437
        for cls in self.__class__.__mro__:
 
1438
            for name, value in inspect.getmembers(
 
1439
                    cls, self._is_dbus_thing("property")):
 
1440
                if (value._dbus_name == property_name
 
1441
                    and value._dbus_interface == interface_name):
 
1442
                    return value.__get__(self)
 
1443
 
 
1444
        # No such property
 
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",
 
1459
                         out_signature="v")
 
1460
    def Get(self, interface_name, property_name):
 
1461
        """Standard D-Bus property Get() method, see D-Bus standard.
 
1462
        """
 
1463
        prop = self._get_dbus_property(interface_name, property_name)
 
1464
        if prop._dbus_access == "write":
 
1465
            raise DBusPropertyAccessException(property_name)
 
1466
        value = prop()
 
1467
        if not hasattr(value, "variant_level"):
 
1468
            return value
 
1469
        return type(value)(value, variant_level=value.variant_level+1)
 
1470
 
 
1471
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
 
1472
    def Set(self, interface_name, property_name, value):
 
1473
        """Standard D-Bus property Set() method, see D-Bus standard.
 
1474
        """
 
1475
        prop = self._get_dbus_property(interface_name, property_name)
 
1476
        if prop._dbus_access == "read":
 
1477
            raise DBusPropertyAccessException(property_name)
 
1478
        if prop._dbus_get_args_options["byte_arrays"]:
 
1479
            # The byte_arrays option is not supported yet on
 
1480
            # signatures other than "ay".
 
1481
            if prop._dbus_signature != "ay":
 
1482
                raise ValueError("Byte arrays not supported for non-"
 
1483
                                 "'ay' signature {!r}"
 
1484
                                 .format(prop._dbus_signature))
 
1485
            value = dbus.ByteArray(bytes(value))
 
1486
        prop(value)
 
1487
 
 
1488
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1489
                         in_signature="s",
 
1490
                         out_signature="a{sv}")
 
1491
    def GetAll(self, interface_name):
 
1492
        """Standard D-Bus property GetAll() method, see D-Bus
 
1493
        standard.
 
1494
 
 
1495
        Note: Will not include properties with access="write".
 
1496
        """
 
1497
        properties = {}
 
1498
        for name, prop in self._get_all_dbus_things("property"):
 
1499
            if (interface_name
 
1500
                and interface_name != prop._dbus_interface):
 
1501
                # Interface non-empty but did not match
 
1502
                continue
 
1503
            # Ignore write-only properties
 
1504
            if prop._dbus_access == "write":
 
1505
                continue
 
1506
            value = prop()
 
1507
            if not hasattr(value, "variant_level"):
 
1508
                properties[name] = value
 
1509
                continue
 
1510
            properties[name] = type(value)(
 
1511
                value, variant_level=value.variant_level + 1)
 
1512
        return dbus.Dictionary(properties, signature="sv")
 
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
 
 
1522
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1523
                         out_signature="s",
 
1524
                         path_keyword="object_path",
 
1525
                         connection_keyword="connection")
 
1526
    def Introspect(self, object_path, connection):
 
1527
        """Overloading of standard D-Bus method.
 
1528
 
 
1529
        Inserts property tags and interface annotation tags.
 
1530
        """
 
1531
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1532
                                                         object_path,
 
1533
                                                         connection)
 
1534
        try:
 
1535
            document = xml.dom.minidom.parseString(xmlstring)
 
1536
 
 
1537
            def make_tag(document, name, prop):
 
1538
                e = document.createElement("property")
 
1539
                e.setAttribute("name", name)
 
1540
                e.setAttribute("type", prop._dbus_signature)
 
1541
                e.setAttribute("access", prop._dbus_access)
 
1542
                return e
 
1543
 
 
1544
            for if_tag in document.getElementsByTagName("interface"):
 
1545
                # Add property tags
 
1546
                for tag in (make_tag(document, name, prop)
 
1547
                            for name, prop
 
1548
                            in self._get_all_dbus_things("property")
 
1549
                            if prop._dbus_interface
 
1550
                            == if_tag.getAttribute("name")):
 
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)
 
1568
                # Add the names to the return values for the
 
1569
                # "org.freedesktop.DBus.Properties" methods
 
1570
                if (if_tag.getAttribute("name")
 
1571
                    == "org.freedesktop.DBus.Properties"):
 
1572
                    for cn in if_tag.getElementsByTagName("method"):
 
1573
                        if cn.getAttribute("name") == "Get":
 
1574
                            for arg in cn.getElementsByTagName("arg"):
 
1575
                                if (arg.getAttribute("direction")
 
1576
                                    == "out"):
 
1577
                                    arg.setAttribute("name", "value")
 
1578
                        elif cn.getAttribute("name") == "GetAll":
 
1579
                            for arg in cn.getElementsByTagName("arg"):
 
1580
                                if (arg.getAttribute("direction")
 
1581
                                    == "out"):
 
1582
                                    arg.setAttribute("name", "props")
 
1583
            xmlstring = document.toxml("utf-8")
 
1584
            document.unlink()
 
1585
        except (AttributeError, xml.dom.DOMException,
 
1586
                xml.parsers.expat.ExpatError) as error:
 
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):
 
1664
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
1665
    if dt is None:
 
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).
 
1692
    """
 
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):
 
1701
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
1702
                # with the wrong interface name
 
1703
                if (not hasattr(attribute, "_dbus_interface")
 
1704
                    or not attribute._dbus_interface.startswith(
 
1705
                        orig_interface_name)):
 
1706
                    continue
 
1707
                # Create an alternate D-Bus interface name based on
 
1708
                # the current name
 
1709
                alt_interface = attribute._dbus_interface.replace(
 
1710
                    orig_interface_name, alt_interface_name)
 
1711
                interface_names.add(alt_interface)
 
1712
                # Is this a D-Bus signal?
 
1713
                if getattr(attribute, "_dbus_is_signal", False):
 
1714
                    # Extract the original non-method undecorated
 
1715
                    # function by black magic
 
1716
                    if sys.version_info.major == 2:
 
1717
                        nonmethod_func = (dict(
 
1718
                            zip(attribute.func_code.co_freevars,
 
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)
 
1726
                    # Create a new, but exactly alike, function
 
1727
                    # object, and decorate it to be a new D-Bus signal
 
1728
                    # with the alternate D-Bus interface name
 
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
 
 
1740
                    # Define a creator of a function to call both the
 
1741
                    # original and alternate functions, so both the
 
1742
                    # original and alternate signals gets sent when
 
1743
                    # the function is called
 
1744
                    def fixscope(func1, func2):
 
1745
                        """This function is a scope container to pass
 
1746
                        func1 and func2 to the "call_both" function
 
1747
                        outside of its arguments"""
 
1748
 
 
1749
                        @functools.wraps(func2)
 
1750
                        def call_both(*args, **kwargs):
 
1751
                            """This function will emit two D-Bus
 
1752
                            signals by calling func1 and func2"""
 
1753
                            func1(*args, **kwargs)
 
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
 
 
1761
                        return call_both
 
1762
                    # Create the "call_both" function and add it to
 
1763
                    # the class
 
1764
                    attr[attrname] = fixscope(attribute, new_function)
 
1765
                # Is this a D-Bus method?
 
1766
                elif getattr(attribute, "_dbus_is_method", False):
 
1767
                    # Create a new, but exactly alike, function
 
1768
                    # object.  Decorate it to be a new D-Bus method
 
1769
                    # with the alternate D-Bus interface name.  Add it
 
1770
                    # to the class.
 
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
 
1783
                # Is this a D-Bus property?
 
1784
                elif getattr(attribute, "_dbus_is_property", False):
 
1785
                    # Create a new, but exactly alike, function
 
1786
                    # object, and decorate it to be a new D-Bus
 
1787
                    # property with the alternate D-Bus interface
 
1788
                    # name.  Add it to the class.
 
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"})
 
1841
class ClientDBus(Client, DBusObjectWithProperties):
 
1842
    """A Client class using D-Bus
 
1843
 
 
1844
    Attributes:
 
1845
    dbus_object_path: dbus.ObjectPath
 
1846
    bus: dbus.SystemBus()
 
1847
    """
 
1848
 
 
1849
    runtime_expansions = (Client.runtime_expansions
 
1850
                          + ("dbus_object_path", ))
 
1851
 
 
1852
    _interface = "se.recompile.Mandos.Client"
 
1853
 
 
1854
    # dbus.service.Object doesn't use super(), so we can't either.
 
1855
 
 
1856
    def __init__(self, bus=None, *args, **kwargs):
 
1857
        self.bus = bus
 
1858
        Client.__init__(self, *args, **kwargs)
 
1859
        # Only now, when this client is initialized, can it show up on
 
1860
        # the D-Bus
 
1861
        client_object_name = str(self.name).translate(
 
1862
            {ord("."): ord("_"),
 
1863
             ord("-"): ord("_")})
 
1864
        self.dbus_object_path = dbus.ObjectPath(
 
1865
            "/clients/" + client_object_name)
 
1866
        DBusObjectWithProperties.__init__(self, self.bus,
 
1867
                                          self.dbus_object_path)
 
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):
 
1874
        """ Modify a variable so that it's a property which announces
 
1875
        its changes to DBus.
 
1876
 
 
1877
        transform_fun: Function that takes a value and a variant_level
 
1878
                       and transforms it to a D-Bus type.
 
1879
        dbus_name: D-Bus name of the variable
 
1880
        type_func: Function that transform the value before sending it
 
1881
                   to the D-Bus.  Default: no transform
 
1882
        variant_level: D-Bus variant level.  Default: 1
 
1883
        """
 
1884
        attrname = "_{}".format(dbus_name)
 
1885
 
 
1886
        def setter(self, value):
 
1887
            if hasattr(self, "dbus_object_path"):
 
1888
                if (not hasattr(self, attrname) or
 
1889
                    type_func(getattr(self, attrname, None))
 
1890
                    != type_func(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())
 
1906
            setattr(self, attrname, value)
 
1907
 
 
1908
        return property(lambda self: getattr(self, attrname), setter)
 
1909
 
 
1910
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
1911
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
1912
                                             "ApprovalPending",
 
1913
                                             type_func=bool)
 
1914
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
1915
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
1916
                                        "LastEnabled")
 
1917
    checker = notifychangeproperty(
 
1918
        dbus.Boolean, "CheckerRunning",
 
1919
        type_func=lambda checker: checker is not None)
 
1920
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
1921
                                           "LastCheckedOK")
 
1922
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1923
                                               "LastCheckerStatus")
 
1924
    last_approval_request = notifychangeproperty(
 
1925
        datetime_to_dbus, "LastApprovalRequest")
 
1926
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
1927
                                               "ApprovedByDefault")
 
1928
    approval_delay = notifychangeproperty(
 
1929
        dbus.UInt64, "ApprovalDelay",
 
1930
        type_func=lambda td: td.total_seconds() * 1000)
 
1931
    approval_duration = notifychangeproperty(
 
1932
        dbus.UInt64, "ApprovalDuration",
 
1933
        type_func=lambda td: td.total_seconds() * 1000)
 
1934
    host = notifychangeproperty(dbus.String, "Host")
 
1935
    timeout = notifychangeproperty(
 
1936
        dbus.UInt64, "Timeout",
 
1937
        type_func=lambda td: td.total_seconds() * 1000)
 
1938
    extended_timeout = notifychangeproperty(
 
1939
        dbus.UInt64, "ExtendedTimeout",
 
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)
 
1944
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1945
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1946
                                  invalidate_only=True)
 
1947
 
 
1948
    del notifychangeproperty
 
1949
 
 
1950
    def __del__(self, *args, **kwargs):
 
1951
        try:
 
1952
            self.remove_from_connection()
 
1953
        except LookupError:
 
1954
            pass
 
1955
        if hasattr(DBusObjectWithProperties, "__del__"):
 
1956
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
 
1957
        Client.__del__(self, *args, **kwargs)
 
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:
 
1966
            # Emit D-Bus signal
 
1967
            self.CheckerCompleted(dbus.Int16(exitstatus),
 
1968
                                  # This is specific to GNU libC
 
1969
                                  dbus.Int64(exitstatus << 8),
 
1970
                                  dbus.String(command))
 
1971
        else:
 
1972
            # Emit D-Bus signal
 
1973
            self.CheckerCompleted(dbus.Int16(-1),
 
1974
                                  dbus.Int64(
 
1975
                                      # This is specific to GNU libC
 
1976
                                      (exitstatus << 8)
 
1977
                                      | self.last_checker_signal),
 
1978
                                  dbus.String(command))
 
1979
        return ret
 
1980
 
 
1981
    def start_checker(self, *args, **kwargs):
 
1982
        old_checker_pid = getattr(self.checker, "pid", None)
 
1983
        r = Client.start_checker(self, *args, **kwargs)
 
1984
        # Only if new checker process was started
 
1985
        if (self.checker is not None
 
1986
            and old_checker_pid != self.checker.pid):
 
1987
            # Emit D-Bus signal
 
1988
            self.CheckerStarted(self.current_checker_command)
 
1989
        return r
 
1990
 
 
1991
    def _reset_approved(self):
 
1992
        self.approved = None
 
1993
        return False
 
1994
 
 
1995
    def approve(self, value=True):
 
1996
        self.approved = value
 
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
 
 
2007
    # CheckerCompleted - signal
 
2008
    @dbus.service.signal(_interface, signature="nxs")
 
2009
    def CheckerCompleted(self, exitcode, waitstatus, command):
 
2010
        "D-Bus signal"
 
2011
        pass
 
2012
 
 
2013
    # CheckerStarted - signal
 
2014
    @dbus.service.signal(_interface, signature="s")
 
2015
    def CheckerStarted(self, command):
 
2016
        "D-Bus signal"
 
2017
        pass
 
2018
 
 
2019
    # PropertyChanged - signal
 
2020
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
2021
    @dbus.service.signal(_interface, signature="sv")
 
2022
    def PropertyChanged(self, property, value):
 
2023
        "D-Bus signal"
 
2024
        pass
 
2025
 
 
2026
    # GotSecret - signal
 
2027
    @dbus.service.signal(_interface)
 
2028
    def GotSecret(self):
 
2029
        """D-Bus signal
 
2030
        Is sent after a successful transfer of secret from the Mandos
 
2031
        server to mandos-client
 
2032
        """
 
2033
        pass
 
2034
 
 
2035
    # Rejected - signal
 
2036
    @dbus.service.signal(_interface, signature="s")
 
2037
    def Rejected(self, reason):
 
2038
        "D-Bus signal"
 
2039
        pass
 
2040
 
 
2041
    # NeedApproval - signal
 
2042
    @dbus.service.signal(_interface, signature="tb")
 
2043
    def NeedApproval(self, timeout, default):
 
2044
        "D-Bus signal"
 
2045
        return self.need_approval()
 
2046
 
 
2047
    #  Methods
 
2048
 
 
2049
    # Approve - method
 
2050
    @dbus.service.method(_interface, in_signature="b")
 
2051
    def Approve(self, value):
 
2052
        self.approve(value)
 
2053
 
 
2054
    # CheckedOK - method
 
2055
    @dbus.service.method(_interface)
 
2056
    def CheckedOK(self):
 
2057
        self.checked_ok()
 
2058
 
 
2059
    # Enable - method
 
2060
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
2061
    @dbus.service.method(_interface)
 
2062
    def Enable(self):
 
2063
        "D-Bus method"
 
2064
        self.enable()
 
2065
 
 
2066
    # StartChecker - method
 
2067
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
2068
    @dbus.service.method(_interface)
 
2069
    def StartChecker(self):
 
2070
        "D-Bus method"
 
2071
        self.start_checker()
 
2072
 
 
2073
    # Disable - method
 
2074
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
2075
    @dbus.service.method(_interface)
 
2076
    def Disable(self):
 
2077
        "D-Bus method"
 
2078
        self.disable()
 
2079
 
 
2080
    # StopChecker - method
 
2081
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
2082
    @dbus.service.method(_interface)
 
2083
    def StopChecker(self):
 
2084
        self.stop_checker()
 
2085
 
 
2086
    #  Properties
 
2087
 
 
2088
    # ApprovalPending - property
 
2089
    @dbus_service_property(_interface, signature="b", access="read")
 
2090
    def ApprovalPending_dbus_property(self):
 
2091
        return dbus.Boolean(bool(self.approvals_pending))
 
2092
 
 
2093
    # ApprovedByDefault - property
 
2094
    @dbus_service_property(_interface,
 
2095
                           signature="b",
 
2096
                           access="readwrite")
 
2097
    def ApprovedByDefault_dbus_property(self, value=None):
 
2098
        if value is None:       # get
 
2099
            return dbus.Boolean(self.approved_by_default)
 
2100
        self.approved_by_default = bool(value)
 
2101
 
 
2102
    # ApprovalDelay - property
 
2103
    @dbus_service_property(_interface,
 
2104
                           signature="t",
 
2105
                           access="readwrite")
 
2106
    def ApprovalDelay_dbus_property(self, value=None):
 
2107
        if value is None:       # get
 
2108
            return dbus.UInt64(self.approval_delay.total_seconds()
 
2109
                               * 1000)
 
2110
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
 
2111
 
 
2112
    # ApprovalDuration - property
 
2113
    @dbus_service_property(_interface,
 
2114
                           signature="t",
 
2115
                           access="readwrite")
 
2116
    def ApprovalDuration_dbus_property(self, value=None):
 
2117
        if value is None:       # get
 
2118
            return dbus.UInt64(self.approval_duration.total_seconds()
 
2119
                               * 1000)
 
2120
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
 
2121
 
 
2122
    # Name - property
 
2123
    @dbus_annotations(
 
2124
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
2125
    @dbus_service_property(_interface, signature="s", access="read")
 
2126
    def Name_dbus_property(self):
 
2127
        return dbus.String(self.name)
 
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
 
 
2136
    # Fingerprint - property
 
2137
    @dbus_annotations(
 
2138
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
2139
    @dbus_service_property(_interface, signature="s", access="read")
 
2140
    def Fingerprint_dbus_property(self):
 
2141
        return dbus.String(self.fingerprint)
 
2142
 
 
2143
    # Host - property
 
2144
    @dbus_service_property(_interface,
 
2145
                           signature="s",
 
2146
                           access="readwrite")
 
2147
    def Host_dbus_property(self, value=None):
 
2148
        if value is None:       # get
 
2149
            return dbus.String(self.host)
 
2150
        self.host = str(value)
 
2151
 
 
2152
    # Created - property
 
2153
    @dbus_annotations(
 
2154
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
2155
    @dbus_service_property(_interface, signature="s", access="read")
 
2156
    def Created_dbus_property(self):
 
2157
        return datetime_to_dbus(self.created)
 
2158
 
 
2159
    # LastEnabled - property
 
2160
    @dbus_service_property(_interface, signature="s", access="read")
 
2161
    def LastEnabled_dbus_property(self):
 
2162
        return datetime_to_dbus(self.last_enabled)
 
2163
 
 
2164
    # Enabled - property
 
2165
    @dbus_service_property(_interface,
 
2166
                           signature="b",
 
2167
                           access="readwrite")
 
2168
    def Enabled_dbus_property(self, value=None):
 
2169
        if value is None:       # get
 
2170
            return dbus.Boolean(self.enabled)
 
2171
        if value:
 
2172
            self.enable()
 
2173
        else:
 
2174
            self.disable()
 
2175
 
 
2176
    # LastCheckedOK - property
 
2177
    @dbus_service_property(_interface,
 
2178
                           signature="s",
 
2179
                           access="readwrite")
 
2180
    def LastCheckedOK_dbus_property(self, value=None):
 
2181
        if value is not None:
 
2182
            self.checked_ok()
 
2183
            return
 
2184
        return datetime_to_dbus(self.last_checked_ok)
 
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
 
 
2191
    # Expires - property
 
2192
    @dbus_service_property(_interface, signature="s", access="read")
 
2193
    def Expires_dbus_property(self):
 
2194
        return datetime_to_dbus(self.expires)
 
2195
 
 
2196
    # LastApprovalRequest - property
 
2197
    @dbus_service_property(_interface, signature="s", access="read")
 
2198
    def LastApprovalRequest_dbus_property(self):
 
2199
        return datetime_to_dbus(self.last_approval_request)
 
2200
 
 
2201
    # Timeout - property
 
2202
    @dbus_service_property(_interface,
 
2203
                           signature="t",
 
2204
                           access="readwrite")
 
2205
    def Timeout_dbus_property(self, value=None):
 
2206
        if value is None:       # get
 
2207
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
2208
        old_timeout = self.timeout
 
2209
        self.timeout = datetime.timedelta(0, 0, 0, value)
 
2210
        # Reschedule disabling
 
2211
        if self.enabled:
 
2212
            now = datetime.datetime.utcnow()
 
2213
            self.expires += self.timeout - old_timeout
 
2214
            if self.expires <= now:
 
2215
                # The timeout has passed
 
2216
                self.disable()
 
2217
            else:
 
2218
                if (getattr(self, "disable_initiator_tag", None)
 
2219
                    is None):
 
2220
                    return
 
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
 
 
2226
    # ExtendedTimeout - property
 
2227
    @dbus_service_property(_interface,
 
2228
                           signature="t",
 
2229
                           access="readwrite")
 
2230
    def ExtendedTimeout_dbus_property(self, value=None):
 
2231
        if value is None:       # get
 
2232
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
2233
                               * 1000)
 
2234
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
 
2235
 
 
2236
    # Interval - property
 
2237
    @dbus_service_property(_interface,
 
2238
                           signature="t",
 
2239
                           access="readwrite")
 
2240
    def Interval_dbus_property(self, value=None):
 
2241
        if value is None:       # get
 
2242
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
2243
        self.interval = datetime.timedelta(0, 0, 0, value)
 
2244
        if getattr(self, "checker_initiator_tag", None) is None:
 
2245
            return
 
2246
        if self.enabled:
 
2247
            # Reschedule checker run
 
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
 
 
2253
    # Checker - property
 
2254
    @dbus_service_property(_interface,
 
2255
                           signature="s",
 
2256
                           access="readwrite")
 
2257
    def Checker_dbus_property(self, value=None):
 
2258
        if value is None:       # get
 
2259
            return dbus.String(self.checker_command)
 
2260
        self.checker_command = str(value)
 
2261
 
 
2262
    # CheckerRunning - property
 
2263
    @dbus_service_property(_interface,
 
2264
                           signature="b",
 
2265
                           access="readwrite")
 
2266
    def CheckerRunning_dbus_property(self, value=None):
 
2267
        if value is None:       # get
 
2268
            return dbus.Boolean(self.checker is not None)
 
2269
        if value:
 
2270
            self.start_checker()
 
2271
        else:
 
2272
            self.stop_checker()
 
2273
 
 
2274
    # ObjectPath - property
 
2275
    @dbus_annotations(
 
2276
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2277
         "org.freedesktop.DBus.Deprecated": "true"})
 
2278
    @dbus_service_property(_interface, signature="o", access="read")
 
2279
    def ObjectPath_dbus_property(self):
 
2280
        return self.dbus_object_path  # is already a dbus.ObjectPath
 
2281
 
 
2282
    # Secret = property
 
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)
 
2290
    def Secret_dbus_property(self, value):
 
2291
        self.secret = bytes(value)
 
2292
 
 
2293
    del _interface
 
2294
 
 
2295
 
 
2296
class ProxyClient:
 
2297
    def __init__(self, child_pipe, key_id, fpr, address):
 
2298
        self._pipe = child_pipe
 
2299
        self._pipe.send(("init", key_id, fpr, address))
 
2300
        if not self._pipe.recv():
 
2301
            raise KeyError(key_id or fpr)
 
2302
 
 
2303
    def __getattribute__(self, name):
 
2304
        if name == "_pipe":
 
2305
            return super(ProxyClient, self).__getattribute__(name)
 
2306
        self._pipe.send(("getattr", name))
 
2307
        data = self._pipe.recv()
 
2308
        if data[0] == "data":
 
2309
            return data[1]
 
2310
        if data[0] == "function":
 
2311
 
 
2312
            def func(*args, **kwargs):
 
2313
                self._pipe.send(("funcall", name, args, kwargs))
 
2314
                return self._pipe.recv()[1]
 
2315
 
 
2316
            return func
 
2317
 
 
2318
    def __setattr__(self, name, value):
 
2319
        if name == "_pipe":
 
2320
            return super(ProxyClient, self).__setattr__(name, value)
 
2321
        self._pipe.send(("setattr", name, value))
 
2322
 
 
2323
 
 
2324
class ClientHandler(socketserver.BaseRequestHandler, object):
 
2325
    """A class to handle client connections.
 
2326
 
 
2327
    Instantiated once for each connection to handle it.
431
2328
    Note: This will run in its own forked process."""
432
 
    
 
2329
 
433
2330
    def handle(self):
434
 
        logger.debug(u"TCP connection from: %s",
435
 
                     unicode(self.client_address))
436
 
        session = gnutls.connection.ClientSession\
437
 
                  (self.request, gnutls.connection.X509Credentials())
438
 
        
439
 
        line = self.request.makefile().readline()
440
 
        logger.debug(u"Protocol version: %r", line)
441
 
        try:
442
 
            if int(line.strip().split()[0]) > 1:
443
 
                raise RuntimeError
444
 
        except (ValueError, IndexError, RuntimeError), error:
445
 
            logger.error(u"Unknown protocol version: %s", error)
446
 
            return
447
 
        
448
 
        # Note: gnutls.connection.X509Credentials is really a generic
449
 
        # GnuTLS certificate credentials object so long as no X.509
450
 
        # keys are added to it.  Therefore, we can use it here despite
451
 
        # using OpenPGP certificates.
452
 
        
453
 
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
454
 
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
455
 
        #                "+DHE-DSS"))
456
 
        priority = "NORMAL"             # Fallback default, since this
457
 
                                        # MUST be set.
458
 
        if self.server.settings["priority"]:
459
 
            priority = self.server.settings["priority"]
460
 
        gnutls.library.functions.gnutls_priority_set_direct\
461
 
            (session._c_object, priority, None);
462
 
        
463
 
        try:
464
 
            session.handshake()
465
 
        except gnutls.errors.GNUTLSError, error:
466
 
            logger.debug(u"Handshake failed: %s", error)
467
 
            # Do not run session.bye() here: the session is not
468
 
            # established.  Just abandon the request.
469
 
            return
470
 
        try:
471
 
            fpr = fingerprint(peer_certificate(session))
472
 
        except (TypeError, gnutls.errors.GNUTLSError), error:
473
 
            logger.debug(u"Bad certificate: %s", error)
474
 
            session.bye()
475
 
            return
476
 
        logger.debug(u"Fingerprint: %s", fpr)
477
 
        client = None
478
 
        for c in self.server.clients:
479
 
            if c.fingerprint == fpr:
480
 
                client = c
481
 
                break
482
 
        if not client:
483
 
            logger.debug(u"Client not found for fingerprint: %s", fpr)
484
 
            session.bye()
485
 
            return
486
 
        # Have to check if client.still_valid(), since it is possible
487
 
        # that the client timed out while establishing the GnuTLS
488
 
        # session.
489
 
        if not client.still_valid():
490
 
            logger.debug(u"Client %(name)s is invalid", vars(client))
491
 
            session.bye()
492
 
            return
493
 
        sent_size = 0
494
 
        while sent_size < len(client.secret):
495
 
            sent = session.send(client.secret[sent_size:])
496
 
            logger.debug(u"Sent: %d, remaining: %d",
497
 
                         sent, len(client.secret)
498
 
                         - (sent_size + sent))
499
 
            sent_size += sent
500
 
        session.bye()
501
 
 
502
 
 
503
 
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
504
 
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
 
2331
        with contextlib.closing(self.server.child_pipe) as child_pipe:
 
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"))
 
2342
            # Use a fallback default, since this MUST be set.
 
2343
            priority = self.server.gnutls_priority
 
2344
            if priority is None:
 
2345
                priority = "NORMAL"
 
2346
            gnutls.priority_set_direct(session,
 
2347
                                       priority.encode("utf-8"), None)
 
2348
 
 
2349
            # Start communication using the Mandos protocol
 
2350
            # Get protocol number
 
2351
            line = self.request.makefile().readline()
 
2352
            log.debug("Protocol version: %r", line)
 
2353
            try:
 
2354
                if int(line.strip().split()[0]) > 1:
 
2355
                    raise RuntimeError(line)
 
2356
            except (ValueError, IndexError, RuntimeError) as error:
 
2357
                log.error("Unknown protocol version: %s", error)
 
2358
                return
 
2359
 
 
2360
            # Start GnuTLS connection
 
2361
            try:
 
2362
                session.handshake()
 
2363
            except gnutls.Error as error:
 
2364
                log.warning("Handshake failed: %s", error)
 
2365
                # Do not run session.bye() here: the session is not
 
2366
                # established.  Just abandon the request.
 
2367
                return
 
2368
            log.debug("Handshake succeeded")
 
2369
 
 
2370
            approval_required = False
 
2371
            try:
 
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,
 
2396
                                         self.client_address)
 
2397
                except KeyError:
 
2398
                    return
 
2399
 
 
2400
                if client.approval_delay:
 
2401
                    delay = client.approval_delay
 
2402
                    client.approvals_pending += 1
 
2403
                    approval_required = True
 
2404
 
 
2405
                while True:
 
2406
                    if not client.enabled:
 
2407
                        log.info("Client %s is disabled", client.name)
 
2408
                        if self.server.use_dbus:
 
2409
                            # Emit D-Bus signal
 
2410
                            client.Rejected("Disabled")
 
2411
                        return
 
2412
 
 
2413
                    if client.approved or not client.approval_delay:
 
2414
                        # We are approved or approval is disabled
 
2415
                        break
 
2416
                    elif client.approved is None:
 
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",
 
2426
                                    client.name)
 
2427
                        if self.server.use_dbus:
 
2428
                            # Emit D-Bus signal
 
2429
                            client.Rejected("Denied")
 
2430
                        return
 
2431
 
 
2432
                    # wait until timeout or approved
 
2433
                    time = datetime.datetime.now()
 
2434
                    client.changedstate.acquire()
 
2435
                    client.changedstate.wait(delay.total_seconds())
 
2436
                    client.changedstate.release()
 
2437
                    time2 = datetime.datetime.now()
 
2438
                    if (time2 - time) >= delay:
 
2439
                        if not client.approved_by_default:
 
2440
                            log.warning("Client %s timed out while"
 
2441
                                        " waiting for approval",
 
2442
                                        client.name)
 
2443
                            if self.server.use_dbus:
 
2444
                                # Emit D-Bus signal
 
2445
                                client.Rejected("Approval timed out")
 
2446
                            return
 
2447
                        else:
 
2448
                            break
 
2449
                    else:
 
2450
                        delay -= time2 - time
 
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)
 
2459
                # bump the timeout using extended_timeout
 
2460
                client.bump_timeout(client.extended_timeout)
 
2461
                if self.server.use_dbus:
 
2462
                    # Emit D-Bus signal
 
2463
                    client.GotSecret()
 
2464
 
 
2465
            finally:
 
2466
                if approval_required:
 
2467
                    client.approvals_pending -= 1
 
2468
                try:
 
2469
                    session.bye()
 
2470
                except gnutls.Error as error:
 
2471
                    log.warning("GnuTLS bye failed", exc_info=error)
 
2472
 
 
2473
    @staticmethod
 
2474
    def peer_certificate(session):
 
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""
 
2491
        list_size = ctypes.c_uint(1)
 
2492
        cert_list = (gnutls.certificate_get_peers
 
2493
                     (session, ctypes.byref(list_size)))
 
2494
        if not bool(cert_list) and list_size.value != 0:
 
2495
            raise gnutls.Error("error getting peer certificate")
 
2496
        if list_size.value == 0:
 
2497
            return None
 
2498
        cert = cert_list[0]
 
2499
        return ctypes.string_at(cert.data, cert.size)
 
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
 
 
2536
    @staticmethod
 
2537
    def fingerprint(openpgp):
 
2538
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
 
2539
        # New GnuTLS "datum" with the OpenPGP public key
 
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)))
 
2544
        # New empty GnuTLS certificate
 
2545
        crt = gnutls.openpgp_crt_t()
 
2546
        gnutls.openpgp_crt_init(ctypes.byref(crt))
 
2547
        # Import the OpenPGP public key into the certificate
 
2548
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2549
                                  gnutls.OPENPGP_FMT_RAW)
 
2550
        # Verify the self signature in the key
 
2551
        crtverify = ctypes.c_uint()
 
2552
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2553
                                       ctypes.byref(crtverify))
 
2554
        if crtverify.value != 0:
 
2555
            gnutls.openpgp_crt_deinit(crt)
 
2556
            raise gnutls.CertificateSecurityError(code
 
2557
                                                  =crtverify.value)
 
2558
        # New buffer for the fingerprint
 
2559
        buf = ctypes.create_string_buffer(20)
 
2560
        buf_len = ctypes.c_size_t()
 
2561
        # Get the fingerprint from the certificate into the buffer
 
2562
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2563
                                           ctypes.byref(buf_len))
 
2564
        # Deinit the certificate
 
2565
        gnutls.openpgp_crt_deinit(crt)
 
2566
        # Convert the buffer to a Python bytestring
 
2567
        fpr = ctypes.string_at(buf, buf_len.value)
 
2568
        # Convert the bytestring to hexadecimal notation
 
2569
        hex_fpr = binascii.hexlify(fpr).upper()
 
2570
        return hex_fpr
 
2571
 
 
2572
 
 
2573
class MultiprocessingMixIn:
 
2574
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2575
 
 
2576
    def sub_process_main(self, request, address):
 
2577
        try:
 
2578
            self.finish_request(request, address)
 
2579
        except Exception:
 
2580
            self.handle_error(request, address)
 
2581
        self.close_request(request)
 
2582
 
 
2583
    def process_request(self, request, address):
 
2584
        """Start a new process to process the request."""
 
2585
        proc = multiprocessing.Process(target=self.sub_process_main,
 
2586
                                       args=(request, address))
 
2587
        proc.start()
 
2588
        return proc
 
2589
 
 
2590
 
 
2591
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
2592
    """ adds a pipe to the MixIn """
 
2593
 
 
2594
    def process_request(self, request, client_address):
 
2595
        """Overrides and wraps the original process_request().
 
2596
 
 
2597
        This function creates a new pipe in self.pipe
 
2598
        """
 
2599
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
 
2600
 
 
2601
        proc = MultiprocessingMixIn.process_request(self, request,
 
2602
                                                    client_address)
 
2603
        self.child_pipe.close()
 
2604
        self.add_pipe(parent_pipe, proc)
 
2605
 
 
2606
    def add_pipe(self, parent_pipe, proc):
 
2607
        """Dummy function; override as necessary"""
 
2608
        raise NotImplementedError()
 
2609
 
 
2610
 
 
2611
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
 
2612
                     socketserver.TCPServer):
 
2613
    """IPv6-capable TCP server.  Accepts None as address and/or port
 
2614
 
505
2615
    Attributes:
506
 
        settings:       Server settings
507
 
        clients:        Set() of Client objects
 
2616
        enabled:        Boolean; whether this server is activated yet
 
2617
        interface:      None or a network interface name (string)
 
2618
        use_ipv6:       Boolean; to use IPv6 or not
508
2619
    """
509
 
    address_family = socket.AF_INET6
510
 
    def __init__(self, *args, **kwargs):
511
 
        if "settings" in kwargs:
512
 
            self.settings = kwargs["settings"]
513
 
            del kwargs["settings"]
514
 
        if "clients" in kwargs:
515
 
            self.clients = kwargs["clients"]
516
 
            del kwargs["clients"]
517
 
        return super(type(self), self).__init__(*args, **kwargs)
 
2620
 
 
2621
    def __init__(self, server_address, RequestHandlerClass,
 
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
        """
 
2628
        self.interface = interface
 
2629
        if use_ipv6:
 
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.
 
2658
        socketserver.TCPServer.__init__(self, server_address,
 
2659
                                        RequestHandlerClass)
 
2660
 
518
2661
    def server_bind(self):
519
2662
        """This overrides the normal server_bind() function
520
2663
        to bind to an interface if one was specified, and also NOT to
521
2664
        bind to an address or port if they were not specified."""
522
 
        if self.settings["interface"]:
523
 
            # 25 is from /usr/include/asm-i486/socket.h
524
 
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
2665
        global SO_BINDTODEVICE
 
2666
        if self.interface is not None:
 
2667
            if SO_BINDTODEVICE is None:
 
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
525
2672
            try:
526
 
                self.socket.setsockopt(socket.SOL_SOCKET,
527
 
                                       SO_BINDTODEVICE,
528
 
                                       self.settings["interface"])
529
 
            except socket.error, error:
530
 
                if error[0] == errno.EPERM:
531
 
                    logger.warning(u"No permission to"
532
 
                                   u" bind to interface %s",
533
 
                                   self.settings["interface"])
 
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)
534
2686
                else:
535
 
                    raise error
 
2687
                    raise
536
2688
        # Only bind(2) the socket if we really need to.
537
2689
        if self.server_address[0] or self.server_address[1]:
 
2690
            if self.server_address[1]:
 
2691
                self.allow_reuse_address = True
538
2692
            if not self.server_address[0]:
539
 
                in6addr_any = "::"
540
 
                self.server_address = (in6addr_any,
 
2693
                if self.address_family == socket.AF_INET6:
 
2694
                    any_address = "::"  # in6addr_any
 
2695
                else:
 
2696
                    any_address = "0.0.0.0"  # INADDR_ANY
 
2697
                self.server_address = (any_address,
541
2698
                                       self.server_address[1])
542
 
            elif self.server_address[1] is None:
543
 
                self.server_address = (self.server_address[0],
544
 
                                       0)
545
 
            return super(type(self), self).server_bind()
 
2699
            elif not self.server_address[1]:
 
2700
                self.server_address = (self.server_address[0], 0)
 
2701
#                 if self.interface:
 
2702
#                     self.server_address = (self.server_address[0],
 
2703
#                                            0, # port
 
2704
#                                            0, # flowinfo
 
2705
#                                            if_nametoindex
 
2706
#                                            (self.interface))
 
2707
            return socketserver.TCPServer.server_bind(self)
 
2708
 
 
2709
 
 
2710
class MandosServer(IPv6_TCPServer):
 
2711
    """Mandos server.
 
2712
 
 
2713
    Attributes:
 
2714
        clients:        set of Client objects
 
2715
        gnutls_priority GnuTLS priority string
 
2716
        use_dbus:       Boolean; to emit D-Bus signals or not
 
2717
 
 
2718
    Assumes a GLib.MainLoop event loop.
 
2719
    """
 
2720
 
 
2721
    def __init__(self, server_address, RequestHandlerClass,
 
2722
                 interface=None,
 
2723
                 use_ipv6=True,
 
2724
                 clients=None,
 
2725
                 gnutls_priority=None,
 
2726
                 use_dbus=True,
 
2727
                 socketfd=None):
 
2728
        self.enabled = False
 
2729
        self.clients = clients
 
2730
        if self.clients is None:
 
2731
            self.clients = {}
 
2732
        self.use_dbus = use_dbus
 
2733
        self.gnutls_priority = gnutls_priority
 
2734
        IPv6_TCPServer.__init__(self, server_address,
 
2735
                                RequestHandlerClass,
 
2736
                                interface=interface,
 
2737
                                use_ipv6=use_ipv6,
 
2738
                                socketfd=socketfd)
 
2739
 
 
2740
    def server_activate(self):
 
2741
        if self.enabled:
 
2742
            return socketserver.TCPServer.server_activate(self)
 
2743
 
 
2744
    def enable(self):
 
2745
        self.enabled = True
 
2746
 
 
2747
    def add_pipe(self, parent_pipe, proc):
 
2748
        # Call "handle_ipc" for both data and EOF events
 
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):
 
2760
        # error, or the other end of multiprocessing.Pipe has closed
 
2761
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
 
2762
            # Wait for other process to exit
 
2763
            proc.join()
 
2764
            return False
 
2765
 
 
2766
        # Read a request from the child
 
2767
        request = parent_pipe.recv()
 
2768
        command = request[0]
 
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:
 
2783
                    client = c
 
2784
                    break
 
2785
            else:
 
2786
                log.info("Client not found for key ID: %s, address:"
 
2787
                         " %s", key_id or fpr, address)
 
2788
                if self.use_dbus:
 
2789
                    # Emit D-Bus signal
 
2790
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
 
2791
                                                       address[0])
 
2792
                parent_pipe.send(False)
 
2793
                return False
 
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))
 
2802
            parent_pipe.send(True)
 
2803
            # remove the old hook in favor of the new above hook on
 
2804
            # same fileno
 
2805
            return False
 
2806
        if command == "funcall":
 
2807
            funcname = request[1]
 
2808
            args = request[2]
 
2809
            kwargs = request[3]
 
2810
 
 
2811
            parent_pipe.send(("data", getattr(client_object,
 
2812
                                              funcname)(*args,
 
2813
                                                        **kwargs)))
 
2814
 
 
2815
        if command == "getattr":
 
2816
            attrname = request[1]
 
2817
            if isinstance(client_object.__getattribute__(attrname),
 
2818
                          collections.abc.Callable):
 
2819
                parent_pipe.send(("function", ))
 
2820
            else:
 
2821
                parent_pipe.send((
 
2822
                    "data", client_object.__getattribute__(attrname)))
 
2823
 
 
2824
        if command == "setattr":
 
2825
            attrname = request[1]
 
2826
            value = request[2]
 
2827
            setattr(client_object, attrname, value)
 
2828
 
 
2829
        return True
 
2830
 
 
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
546
2931
 
547
2932
 
548
2933
def string_to_delta(interval):
549
2934
    """Parse a string and return a datetime.timedelta
550
2935
 
551
 
    >>> string_to_delta('7d')
552
 
    datetime.timedelta(7)
553
 
    >>> string_to_delta('60s')
554
 
    datetime.timedelta(0, 60)
555
 
    >>> string_to_delta('60m')
556
 
    datetime.timedelta(0, 3600)
557
 
    >>> string_to_delta('24h')
558
 
    datetime.timedelta(1)
559
 
    >>> string_to_delta(u'1w')
560
 
    datetime.timedelta(7)
 
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
561
2948
    """
562
 
    try:
563
 
        suffix=unicode(interval[-1])
564
 
        value=int(interval[:-1])
565
 
        if suffix == u"d":
566
 
            delta = datetime.timedelta(value)
567
 
        elif suffix == u"s":
568
 
            delta = datetime.timedelta(0, value)
569
 
        elif suffix == u"m":
570
 
            delta = datetime.timedelta(0, 0, 0, 0, value)
571
 
        elif suffix == u"h":
572
 
            delta = datetime.timedelta(0, 0, 0, 0, 0, value)
573
 
        elif suffix == u"w":
574
 
            delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
575
 
        else:
576
 
            raise ValueError
577
 
    except (ValueError, IndexError):
578
 
        raise ValueError
579
 
    return delta
580
 
 
581
 
 
582
 
def server_state_changed(state):
583
 
    """Derived from the Avahi example code"""
584
 
    if state == avahi.SERVER_COLLISION:
585
 
        logger.warning(u"Server name collision")
586
 
        service.remove()
587
 
    elif state == avahi.SERVER_RUNNING:
588
 
        service.add()
589
 
 
590
 
 
591
 
def entry_group_state_changed(state, error):
592
 
    """Derived from the Avahi example code"""
593
 
    logger.debug(u"state change: %i", state)
594
 
    
595
 
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
596
 
        logger.debug(u"Service established.")
597
 
    elif state == avahi.ENTRY_GROUP_COLLISION:
598
 
        logger.warning(u"Service name collision.")
599
 
        service.rename()
600
 
    elif state == avahi.ENTRY_GROUP_FAILURE:
601
 
        logger.critical(u"Error in group state changed %s",
602
 
                        unicode(error))
603
 
        raise AvahiGroupError("State changed: %s", str(error))
604
 
 
605
 
def if_nametoindex(interface):
606
 
    """Call the C function if_nametoindex(), or equivalent"""
607
 
    global if_nametoindex
608
 
    try:
609
 
        if "ctypes.util" not in sys.modules:
610
 
            import ctypes.util
611
 
        if_nametoindex = ctypes.cdll.LoadLibrary\
612
 
            (ctypes.util.find_library("c")).if_nametoindex
613
 
    except (OSError, AttributeError):
614
 
        if "struct" not in sys.modules:
615
 
            import struct
616
 
        if "fcntl" not in sys.modules:
617
 
            import fcntl
618
 
        def if_nametoindex(interface):
619
 
            "Get an interface index the hard way, i.e. using fcntl()"
620
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
621
 
            s = socket.socket()
622
 
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
623
 
                                struct.pack("16s16x", interface))
624
 
            s.close()
625
 
            interface_index = struct.unpack("I", ifreq[16:20])[0]
626
 
            return interface_index
627
 
    return if_nametoindex(interface)
628
 
 
629
 
 
630
 
def daemon(nochdir, noclose):
 
2949
 
 
2950
    try:
 
2951
        return rfc3339_duration_to_delta(interval)
 
2952
    except ValueError:
 
2953
        pass
 
2954
 
 
2955
    timevalue = datetime.timedelta(0)
 
2956
    for s in interval.split():
 
2957
        try:
 
2958
            suffix = s[-1]
 
2959
            value = int(s[:-1])
 
2960
            if suffix == "d":
 
2961
                delta = datetime.timedelta(value)
 
2962
            elif suffix == "s":
 
2963
                delta = datetime.timedelta(0, value)
 
2964
            elif suffix == "m":
 
2965
                delta = datetime.timedelta(0, 0, 0, 0, value)
 
2966
            elif suffix == "h":
 
2967
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
2968
            elif suffix == "w":
 
2969
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
2970
            else:
 
2971
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2972
        except IndexError as e:
 
2973
            raise ValueError(*(e.args))
 
2974
        timevalue += delta
 
2975
    return timevalue
 
2976
 
 
2977
 
 
2978
def daemon(nochdir=False, noclose=False):
631
2979
    """See daemon(3).  Standard BSD Unix function.
 
2980
 
632
2981
    This should really exist as os.daemon, but it doesn't (yet)."""
633
2982
    if os.fork():
634
2983
        sys.exit()
635
2984
    os.setsid()
636
2985
    if not nochdir:
637
2986
        os.chdir("/")
 
2987
    if os.fork():
 
2988
        sys.exit()
638
2989
    if not noclose:
639
2990
        # Close all standard open file descriptors
640
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2991
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
641
2992
        if not stat.S_ISCHR(os.fstat(null).st_mode):
642
2993
            raise OSError(errno.ENODEV,
643
 
                          "/dev/null not a character device")
 
2994
                          "{} not a character device"
 
2995
                          .format(os.devnull))
644
2996
        os.dup2(null, sys.stdin.fileno())
645
2997
        os.dup2(null, sys.stdout.fileno())
646
2998
        os.dup2(null, sys.stderr.fileno())
649
3001
 
650
3002
 
651
3003
def main():
652
 
    global main_loop_started
653
 
    main_loop_started = False
654
 
    
655
 
    parser = OptionParser()
656
 
    parser.add_option("-i", "--interface", type="string",
657
 
                      metavar="IF", help="Bind to interface IF")
658
 
    parser.add_option("-a", "--address", type="string",
659
 
                      help="Address to listen for requests on")
660
 
    parser.add_option("-p", "--port", type="int",
661
 
                      help="Port number to receive requests on")
662
 
    parser.add_option("--check", action="store_true", default=False,
663
 
                      help="Run self-test")
664
 
    parser.add_option("--debug", action="store_true", default=False,
665
 
                      help="Debug mode; run in foreground and log to"
666
 
                      " terminal")
667
 
    parser.add_option("--priority", type="string", help="GnuTLS"
668
 
                      " priority string (see GnuTLS documentation)")
669
 
    parser.add_option("--servicename", type="string", metavar="NAME",
670
 
                      help="Zeroconf service name")
671
 
    parser.add_option("--configdir", type="string",
672
 
                      default="/etc/mandos", metavar="DIR",
673
 
                      help="Directory to search for configuration"
674
 
                      " files")
675
 
    (options, args) = parser.parse_args()
676
 
    
677
 
    if options.check:
678
 
        import doctest
679
 
        doctest.testmod()
680
 
        sys.exit()
681
 
    
 
3004
 
 
3005
    ##################################################################
 
3006
    # Parsing of options, both command line and config file
 
3007
 
 
3008
    parser = argparse.ArgumentParser()
 
3009
    parser.add_argument("-v", "--version", action="version",
 
3010
                        version="%(prog)s {}".format(version),
 
3011
                        help="show version number and exit")
 
3012
    parser.add_argument("-i", "--interface", metavar="IF",
 
3013
                        help="Bind to interface IF")
 
3014
    parser.add_argument("-a", "--address",
 
3015
                        help="Address to listen for requests on")
 
3016
    parser.add_argument("-p", "--port", type=int,
 
3017
                        help="Port number to receive requests on")
 
3018
    parser.add_argument("--check", action="store_true",
 
3019
                        help="Run self-test")
 
3020
    parser.add_argument("--debug", action="store_true",
 
3021
                        help="Debug mode; run in foreground and log"
 
3022
                        " to terminal", default=None)
 
3023
    parser.add_argument("--debuglevel", metavar="LEVEL",
 
3024
                        help="Debug level for stdout output")
 
3025
    parser.add_argument("--priority", help="GnuTLS"
 
3026
                        " priority string (see GnuTLS documentation)")
 
3027
    parser.add_argument("--servicename",
 
3028
                        metavar="NAME", help="Zeroconf service name")
 
3029
    parser.add_argument("--configdir",
 
3030
                        default="/etc/mandos", metavar="DIR",
 
3031
                        help="Directory to search for configuration"
 
3032
                        " files")
 
3033
    parser.add_argument("--no-dbus", action="store_false",
 
3034
                        dest="use_dbus", help="Do not provide D-Bus"
 
3035
                        " system bus interface", default=None)
 
3036
    parser.add_argument("--no-ipv6", action="store_false",
 
3037
                        dest="use_ipv6", help="Do not use IPv6",
 
3038
                        default=None)
 
3039
    parser.add_argument("--no-restore", action="store_false",
 
3040
                        dest="restore", help="Do not restore stored"
 
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")
 
3045
    parser.add_argument("--statedir", metavar="DIR",
 
3046
                        help="Directory to save/restore state in")
 
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
 
 
3053
    options = parser.parse_args()
 
3054
 
682
3055
    # Default values for config file for server-global settings
683
 
    server_defaults = { "interface": "",
684
 
                        "address": "",
685
 
                        "port": "",
686
 
                        "debug": "False",
687
 
                        "priority":
688
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
689
 
                        "servicename": "Mandos",
690
 
                        }
691
 
    
 
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
 
692
3079
    # Parse config file for server-global settings
693
 
    server_config = ConfigParser.SafeConfigParser(server_defaults)
 
3080
    server_config = configparser.ConfigParser(server_defaults)
694
3081
    del server_defaults
695
 
    server_config.read(os.path.join(options.configdir, "server.conf"))
696
 
    server_section = "server"
697
 
    # Convert the SafeConfigParser object to a dict
698
 
    server_settings = dict(server_config.items(server_section))
699
 
    # Use getboolean on the boolean config option
700
 
    server_settings["debug"] = server_config.getboolean\
701
 
                               (server_section, "debug")
 
3082
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
3083
    # Convert the ConfigParser object to a dict
 
3084
    server_settings = server_config.defaults()
 
3085
    # Use the appropriate methods on the non-string config options
 
3086
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
3087
                   "foreground", "zeroconf"):
 
3088
        server_settings[option] = server_config.getboolean("DEFAULT",
 
3089
                                                           option)
 
3090
    if server_settings["port"]:
 
3091
        server_settings["port"] = server_config.getint("DEFAULT",
 
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"])
702
3102
    del server_config
703
 
    
 
3103
 
704
3104
    # Override the settings from the config file with command line
705
3105
    # options, if set.
706
3106
    for option in ("interface", "address", "port", "debug",
707
 
                   "priority", "servicename", "configdir"):
 
3107
                   "priority", "servicename", "configdir", "use_dbus",
 
3108
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
3109
                   "socket", "foreground", "zeroconf"):
708
3110
        value = getattr(options, option)
709
3111
        if value is not None:
710
3112
            server_settings[option] = value
711
3113
    del options
 
3114
    # Force all strings to be unicode
 
3115
    for option in server_settings.keys():
 
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
712
3126
    # Now we have our good server settings in "server_settings"
713
 
    
 
3127
 
 
3128
    ##################################################################
 
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
 
 
3135
    # For convenience
 
3136
    debug = server_settings["debug"]
 
3137
    debuglevel = server_settings["debuglevel"]
 
3138
    use_dbus = server_settings["use_dbus"]
 
3139
    use_ipv6 = server_settings["use_ipv6"]
 
3140
    stored_state_path = os.path.join(server_settings["statedir"],
 
3141
                                     stored_state_file)
 
3142
    foreground = server_settings["foreground"]
 
3143
    zeroconf = server_settings["zeroconf"]
 
3144
 
 
3145
    if debug:
 
3146
        initlogger(debug, logging.DEBUG)
 
3147
    else:
 
3148
        if not debuglevel:
 
3149
            initlogger(debug)
 
3150
        else:
 
3151
            level = getattr(logging, debuglevel.upper())
 
3152
            initlogger(debug, level)
 
3153
 
 
3154
    if server_settings["servicename"] != "Mandos":
 
3155
        syslogger.setFormatter(
 
3156
            logging.Formatter("Mandos ({}) [%(process)d]:"
 
3157
                              " %(levelname)s: %(message)s".format(
 
3158
                                  server_settings["servicename"])))
 
3159
 
714
3160
    # Parse config file with clients
715
 
    client_defaults = { "timeout": "1h",
716
 
                        "interval": "5m",
717
 
                        "checker": "fping -q -- %%(fqdn)s",
718
 
                        }
719
 
    client_config = ConfigParser.SafeConfigParser(client_defaults)
 
3161
    client_config = configparser.ConfigParser(Client.client_defaults)
720
3162
    client_config.read(os.path.join(server_settings["configdir"],
721
3163
                                    "clients.conf"))
722
 
    
723
 
    global service
724
 
    service = AvahiService(name = server_settings["servicename"],
725
 
                           type = "_mandos._tcp", );
726
 
    if server_settings["interface"]:
727
 
        service.interface = if_nametoindex(server_settings["interface"])
728
 
    
 
3164
 
 
3165
    global mandos_dbus_service
 
3166
    mandos_dbus_service = None
 
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
 
3197
        except KeyError:
 
3198
            continue
 
3199
    else:
 
3200
        uid = 65534
 
3201
        gid = 65534
 
3202
    try:
 
3203
        os.setgid(gid)
 
3204
        os.setuid(uid)
 
3205
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
 
3206
    except OSError as error:
 
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
 
 
3212
    if debug:
 
3213
        # Enable all possible GnuTLS debugging
 
3214
 
 
3215
        # "Use a log level over 10 to enable all debugging options."
 
3216
        # - GnuTLS manual
 
3217
        gnutls.global_set_log_level(11)
 
3218
 
 
3219
        @gnutls.log_func
 
3220
        def debug_gnutls(level, string):
 
3221
            log.debug("GnuTLS: %s",
 
3222
                      string[:-1].decode("utf-8", errors="replace"))
 
3223
 
 
3224
        gnutls.global_set_log_function(debug_gnutls)
 
3225
 
 
3226
        # Redirect stdin so all checkers get /dev/null
 
3227
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
3228
        os.dup2(null, sys.stdin.fileno())
 
3229
        if null > 2:
 
3230
            os.close(null)
 
3231
 
 
3232
    # Need to fork before connecting to D-Bus
 
3233
    if not foreground:
 
3234
        # Close all input and output, do double fork, etc.
 
3235
        daemon()
 
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
 
729
3242
    global main_loop
730
 
    global bus
731
 
    global server
732
3243
    # From the Avahi example code
733
 
    DBusGMainLoop(set_as_default=True )
734
 
    main_loop = gobject.MainLoop()
735
 
    bus = dbus.SystemBus()
736
 
    server = dbus.Interface(
737
 
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
738
 
            avahi.DBUS_INTERFACE_SERVER )
 
3244
    DBusGMainLoop(set_as_default=True)
 
3245
    main_loop = GLib.MainLoop()
 
3246
    if use_dbus or zeroconf:
 
3247
        bus = dbus.SystemBus()
739
3248
    # End of Avahi example code
740
 
    
741
 
    debug = server_settings["debug"]
742
 
    
743
 
    if debug:
744
 
        console = logging.StreamHandler()
745
 
        # console.setLevel(logging.DEBUG)
746
 
        console.setFormatter(logging.Formatter\
747
 
                             ('%(levelname)s: %(message)s'))
748
 
        logger.addHandler(console)
749
 
        del console
750
 
    
751
 
    clients = Set()
752
 
    def remove_from_clients(client):
753
 
        clients.remove(client)
754
 
        if not clients:
755
 
            logger.debug(u"No clients left, exiting")
756
 
            sys.exit()
757
 
    
758
 
    clients.update(Set(Client(name=section,
759
 
                              stop_hook = remove_from_clients,
760
 
                              **(dict(client_config\
761
 
                                      .items(section))))
762
 
                       for section in client_config.sections()))
763
 
    
764
 
    if not debug:
765
 
        daemon(False, False)
766
 
    
 
3249
    if use_dbus:
 
3250
        try:
 
3251
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
3252
                                            bus,
 
3253
                                            do_not_queue=True)
 
3254
            old_bus_name = dbus.service.BusName(
 
3255
                "se.bsnet.fukt.Mandos", bus,
 
3256
                do_not_queue=True)
 
3257
        except dbus.exceptions.DBusException as e:
 
3258
            log.error("Disabling D-Bus:", exc_info=e)
 
3259
            use_dbus = False
 
3260
            server_settings["use_dbus"] = False
 
3261
            tcp_server.use_dbus = False
 
3262
    if zeroconf:
 
3263
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
3264
        service = AvahiServiceToSyslog(
 
3265
            name=server_settings["servicename"],
 
3266
            servicetype="_mandos._tcp",
 
3267
            protocol=protocol,
 
3268
            bus=bus)
 
3269
        if server_settings["interface"]:
 
3270
            service.interface = if_nametoindex(
 
3271
                server_settings["interface"].encode("utf-8"))
 
3272
 
 
3273
    global multiprocessing_manager
 
3274
    multiprocessing_manager = multiprocessing.Manager()
 
3275
 
 
3276
    client_class = Client
 
3277
    if use_dbus:
 
3278
        client_class = functools.partial(ClientDBus, bus=bus)
 
3279
 
 
3280
    client_settings = Client.config_parser(client_config)
 
3281
    old_client_settings = {}
 
3282
    clients_data = {}
 
3283
 
 
3284
    # This is used to redirect stdout and stderr for checker processes
 
3285
    global wnull
 
3286
    wnull = open(os.devnull, "w")  # A writable /dev/null
 
3287
    # Only used if server is running in foreground but not in debug
 
3288
    # mode
 
3289
    if debug or not foreground:
 
3290
        wnull.close()
 
3291
 
 
3292
    # Get client data and settings from last running state.
 
3293
    if server_settings["restore"]:
 
3294
        try:
 
3295
            with open(stored_state_path, "rb") as stored_state:
 
3296
                if sys.version_info.major == 2:
 
3297
                    clients_data, old_client_settings = pickle.load(
 
3298
                        stored_state)
 
3299
                else:
 
3300
                    bytes_clients_data, bytes_old_client_settings = (
 
3301
                        pickle.load(stored_state, encoding="bytes"))
 
3302
                    #   Fix bytes to strings
 
3303
                    #  clients_data
 
3304
                    # .keys()
 
3305
                    clients_data = {(key.decode("utf-8")
 
3306
                                     if isinstance(key, bytes)
 
3307
                                     else key): value
 
3308
                                    for key, value in
 
3309
                                    bytes_clients_data.items()}
 
3310
                    del bytes_clients_data
 
3311
                    for key in clients_data:
 
3312
                        value = {(k.decode("utf-8")
 
3313
                                  if isinstance(k, bytes) else k): v
 
3314
                                 for k, v in
 
3315
                                 clients_data[key].items()}
 
3316
                        clients_data[key] = value
 
3317
                        # .client_structure
 
3318
                        value["client_structure"] = [
 
3319
                            (s.decode("utf-8")
 
3320
                             if isinstance(s, bytes)
 
3321
                             else s) for s in
 
3322
                            value["client_structure"]]
 
3323
                        # .name, .host, and .checker_command
 
3324
                        for k in ("name", "host", "checker_command"):
 
3325
                            if isinstance(value[k], bytes):
 
3326
                                value[k] = value[k].decode("utf-8")
 
3327
                        if "key_id" not in value:
 
3328
                            value["key_id"] = ""
 
3329
                        elif "fingerprint" not in value:
 
3330
                            value["fingerprint"] = ""
 
3331
                    #  old_client_settings
 
3332
                    # .keys()
 
3333
                    old_client_settings = {
 
3334
                        (key.decode("utf-8")
 
3335
                         if isinstance(key, bytes)
 
3336
                         else key): value
 
3337
                        for key, value in
 
3338
                        bytes_old_client_settings.items()}
 
3339
                    del bytes_old_client_settings
 
3340
                    # .host and .checker_command
 
3341
                    for value in old_client_settings.values():
 
3342
                        for attribute in ("host", "checker_command"):
 
3343
                            if isinstance(value[attribute], bytes):
 
3344
                                value[attribute] = (value[attribute]
 
3345
                                                    .decode("utf-8"))
 
3346
            os.remove(stored_state_path)
 
3347
        except IOError as e:
 
3348
            if e.errno == errno.ENOENT:
 
3349
                log.warning("Could not load persistent state:"
 
3350
                            " %s", os.strerror(e.errno))
 
3351
            else:
 
3352
                log.critical("Could not load persistent state:",
 
3353
                             exc_info=e)
 
3354
                raise
 
3355
        except EOFError as e:
 
3356
            log.warning("Could not load persistent state: EOFError:",
 
3357
                        exc_info=e)
 
3358
 
 
3359
    with PGPEngine() as pgp:
 
3360
        for client_name, client in clients_data.items():
 
3361
            # Skip removed clients
 
3362
            if client_name not in client_settings:
 
3363
                continue
 
3364
 
 
3365
            # Decide which value to use after restoring saved state.
 
3366
            # We have three different values: Old config file,
 
3367
            # new config file, and saved state.
 
3368
            # New config value takes precedence if it differs from old
 
3369
            # config value, otherwise use saved state.
 
3370
            for name, value in client_settings[client_name].items():
 
3371
                try:
 
3372
                    # For each value in new config, check if it
 
3373
                    # differs from the old config value (Except for
 
3374
                    # the "secret" attribute)
 
3375
                    if (name != "secret"
 
3376
                        and (value !=
 
3377
                             old_client_settings[client_name][name])):
 
3378
                        client[name] = value
 
3379
                except KeyError:
 
3380
                    pass
 
3381
 
 
3382
            # Clients who has passed its expire date can still be
 
3383
            # enabled if its last checker was successful.  A Client
 
3384
            # whose checker succeeded before we stored its state is
 
3385
            # assumed to have successfully run all checkers during
 
3386
            # downtime.
 
3387
            if client["enabled"]:
 
3388
                if datetime.datetime.utcnow() >= client["expires"]:
 
3389
                    if not client["last_checked_ok"]:
 
3390
                        log.warning("disabling client %s - Client"
 
3391
                                    " never performed a successful"
 
3392
                                    " checker", client_name)
 
3393
                        client["enabled"] = False
 
3394
                    elif client["last_checker_status"] != 0:
 
3395
                        log.warning("disabling client %s - Client"
 
3396
                                    " last checker failed with error"
 
3397
                                    " code %s", client_name,
 
3398
                                    client["last_checker_status"])
 
3399
                        client["enabled"] = False
 
3400
                    else:
 
3401
                        client["expires"] = (
 
3402
                            datetime.datetime.utcnow()
 
3403
                            + client["timeout"])
 
3404
                        log.debug("Last checker succeeded, keeping %s"
 
3405
                                  " enabled", client_name)
 
3406
            try:
 
3407
                client["secret"] = pgp.decrypt(
 
3408
                    client["encrypted_secret"],
 
3409
                    client_settings[client_name]["secret"])
 
3410
            except PGPError:
 
3411
                # If decryption fails, we use secret from new settings
 
3412
                log.debug("Failed to decrypt %s old secret",
 
3413
                          client_name)
 
3414
                client["secret"] = (client_settings[client_name]
 
3415
                                    ["secret"])
 
3416
 
 
3417
    # Add/remove clients based on new changes made to config
 
3418
    for client_name in (set(old_client_settings)
 
3419
                        - set(client_settings)):
 
3420
        del clients_data[client_name]
 
3421
    for client_name in (set(client_settings)
 
3422
                        - set(old_client_settings)):
 
3423
        clients_data[client_name] = client_settings[client_name]
 
3424
 
 
3425
    # Create all client objects
 
3426
    for client_name, client in clients_data.items():
 
3427
        tcp_server.clients[client_name] = client_class(
 
3428
            name=client_name,
 
3429
            settings=client,
 
3430
            server_settings=server_settings)
 
3431
 
 
3432
    if not tcp_server.clients:
 
3433
        log.warning("No clients defined")
 
3434
 
 
3435
    if not foreground:
 
3436
        if pidfile is not None:
 
3437
            pid = os.getpid()
 
3438
            try:
 
3439
                with pidfile:
 
3440
                    print(pid, file=pidfile)
 
3441
            except IOError:
 
3442
                log.error("Could not write to file %r with PID %d",
 
3443
                          pidfilename, pid)
 
3444
        del pidfile
 
3445
        del pidfilename
 
3446
 
 
3447
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
3448
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
3449
                             lambda: main_loop.quit() and False)
 
3450
 
 
3451
    if use_dbus:
 
3452
 
 
3453
        @alternate_dbus_interfaces(
 
3454
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
 
3455
        class MandosDBusService(DBusObjectWithObjectManager):
 
3456
            """A D-Bus proxy object"""
 
3457
 
 
3458
            def __init__(self):
 
3459
                dbus.service.Object.__init__(self, bus, "/")
 
3460
 
 
3461
            _interface = "se.recompile.Mandos"
 
3462
 
 
3463
            @dbus.service.signal(_interface, signature="o")
 
3464
            def ClientAdded(self, objpath):
 
3465
                "D-Bus signal"
 
3466
                pass
 
3467
 
 
3468
            @dbus.service.signal(_interface, signature="ss")
 
3469
            def ClientNotFound(self, key_id, address):
 
3470
                "D-Bus signal"
 
3471
                pass
 
3472
 
 
3473
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3474
                               "true"})
 
3475
            @dbus.service.signal(_interface, signature="os")
 
3476
            def ClientRemoved(self, objpath, name):
 
3477
                "D-Bus signal"
 
3478
                pass
 
3479
 
 
3480
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3481
                               "true"})
 
3482
            @dbus.service.method(_interface, out_signature="ao")
 
3483
            def GetAllClients(self):
 
3484
                "D-Bus method"
 
3485
                return dbus.Array(c.dbus_object_path for c in
 
3486
                                  tcp_server.clients.values())
 
3487
 
 
3488
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3489
                               "true"})
 
3490
            @dbus.service.method(_interface,
 
3491
                                 out_signature="a{oa{sv}}")
 
3492
            def GetAllClientsWithProperties(self):
 
3493
                "D-Bus method"
 
3494
                return dbus.Dictionary(
 
3495
                    {c.dbus_object_path: c.GetAll(
 
3496
                        "se.recompile.Mandos.Client")
 
3497
                     for c in tcp_server.clients.values()},
 
3498
                    signature="oa{sv}")
 
3499
 
 
3500
            @dbus.service.method(_interface, in_signature="o")
 
3501
            def RemoveClient(self, object_path):
 
3502
                "D-Bus method"
 
3503
                for c in tcp_server.clients.values():
 
3504
                    if c.dbus_object_path == object_path:
 
3505
                        del tcp_server.clients[c.name]
 
3506
                        c.remove_from_connection()
 
3507
                        # Don't signal the disabling
 
3508
                        c.disable(quiet=True)
 
3509
                        # Emit D-Bus signal for removal
 
3510
                        self.client_removed_signal(c)
 
3511
                        return
 
3512
                raise KeyError(object_path)
 
3513
 
 
3514
            del _interface
 
3515
 
 
3516
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
3517
                                 out_signature="a{oa{sa{sv}}}")
 
3518
            def GetManagedObjects(self):
 
3519
                """D-Bus method"""
 
3520
                return dbus.Dictionary(
 
3521
                    {client.dbus_object_path:
 
3522
                     dbus.Dictionary(
 
3523
                         {interface: client.GetAll(interface)
 
3524
                          for interface in
 
3525
                          client._get_all_interface_names()})
 
3526
                     for client in tcp_server.clients.values()})
 
3527
 
 
3528
            def client_added_signal(self, client):
 
3529
                """Send the new standard signal and the old signal"""
 
3530
                if use_dbus:
 
3531
                    # New standard signal
 
3532
                    self.InterfacesAdded(
 
3533
                        client.dbus_object_path,
 
3534
                        dbus.Dictionary(
 
3535
                            {interface: client.GetAll(interface)
 
3536
                             for interface in
 
3537
                             client._get_all_interface_names()}))
 
3538
                    # Old signal
 
3539
                    self.ClientAdded(client.dbus_object_path)
 
3540
 
 
3541
            def client_removed_signal(self, client):
 
3542
                """Send the new standard signal and the old signal"""
 
3543
                if use_dbus:
 
3544
                    # New standard signal
 
3545
                    self.InterfacesRemoved(
 
3546
                        client.dbus_object_path,
 
3547
                        client._get_all_interface_names())
 
3548
                    # Old signal
 
3549
                    self.ClientRemoved(client.dbus_object_path,
 
3550
                                       client.name)
 
3551
 
 
3552
        mandos_dbus_service = MandosDBusService()
 
3553
 
 
3554
    # Save modules to variables to exempt the modules from being
 
3555
    # unloaded before the function registered with atexit() is run.
 
3556
    mp = multiprocessing
 
3557
    wn = wnull
 
3558
 
767
3559
    def cleanup():
768
3560
        "Cleanup function; run on exit"
769
 
        global group
770
 
        # From the Avahi example code
771
 
        if not group is None:
772
 
            group.Free()
773
 
            group = None
774
 
        # End of Avahi example code
775
 
        
776
 
        while clients:
777
 
            client = clients.pop()
778
 
            client.stop_hook = None
779
 
            client.stop()
780
 
    
 
3561
        if zeroconf:
 
3562
            service.cleanup()
 
3563
 
 
3564
        mp.active_children()
 
3565
        wn.close()
 
3566
        if not (tcp_server.clients or client_settings):
 
3567
            return
 
3568
 
 
3569
        # Store client before exiting. Secrets are encrypted with key
 
3570
        # based on what config file has. If config file is
 
3571
        # removed/edited, old secret will thus be unrecovable.
 
3572
        clients = {}
 
3573
        with PGPEngine() as pgp:
 
3574
            for client in tcp_server.clients.values():
 
3575
                key = client_settings[client.name]["secret"]
 
3576
                client.encrypted_secret = pgp.encrypt(client.secret,
 
3577
                                                      key)
 
3578
                client_dict = {}
 
3579
 
 
3580
                # A list of attributes that can not be pickled
 
3581
                # + secret.
 
3582
                exclude = {"bus", "changedstate", "secret",
 
3583
                           "checker", "server_settings"}
 
3584
                for name, typ in inspect.getmembers(dbus.service
 
3585
                                                    .Object):
 
3586
                    exclude.add(name)
 
3587
 
 
3588
                client_dict["encrypted_secret"] = (client
 
3589
                                                   .encrypted_secret)
 
3590
                for attr in client.client_structure:
 
3591
                    if attr not in exclude:
 
3592
                        client_dict[attr] = getattr(client, attr)
 
3593
 
 
3594
                clients[client.name] = client_dict
 
3595
                del client_settings[client.name]["secret"]
 
3596
 
 
3597
        try:
 
3598
            with tempfile.NamedTemporaryFile(
 
3599
                    mode="wb",
 
3600
                    suffix=".pickle",
 
3601
                    prefix="clients-",
 
3602
                    dir=os.path.dirname(stored_state_path),
 
3603
                    delete=False) as stored_state:
 
3604
                pickle.dump((clients, client_settings), stored_state,
 
3605
                            protocol=2)
 
3606
                tempname = stored_state.name
 
3607
            os.rename(tempname, stored_state_path)
 
3608
        except (IOError, OSError) as e:
 
3609
            if not debug:
 
3610
                try:
 
3611
                    os.remove(tempname)
 
3612
                except NameError:
 
3613
                    pass
 
3614
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
3615
                log.warning("Could not save persistent state: %s",
 
3616
                            os.strerror(e.errno))
 
3617
            else:
 
3618
                log.warning("Could not save persistent state:",
 
3619
                            exc_info=e)
 
3620
                raise
 
3621
 
 
3622
        # Delete all clients, and settings from config
 
3623
        while tcp_server.clients:
 
3624
            name, client = tcp_server.clients.popitem()
 
3625
            if use_dbus:
 
3626
                client.remove_from_connection()
 
3627
            # Don't signal the disabling
 
3628
            client.disable(quiet=True)
 
3629
            # Emit D-Bus signal for removal
 
3630
            if use_dbus:
 
3631
                mandos_dbus_service.client_removed_signal(client)
 
3632
        client_settings.clear()
 
3633
 
781
3634
    atexit.register(cleanup)
782
 
    
783
 
    if not debug:
784
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
785
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
786
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
787
 
    
788
 
    for client in clients:
789
 
        client.start()
790
 
    
791
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
792
 
                                 server_settings["port"]),
793
 
                                tcp_handler,
794
 
                                settings=server_settings,
795
 
                                clients=clients)
 
3635
 
 
3636
    for client in tcp_server.clients.values():
 
3637
        if use_dbus:
 
3638
            # Emit D-Bus signal for adding
 
3639
            mandos_dbus_service.client_added_signal(client)
 
3640
        # Need to initiate checking of clients
 
3641
        if client.enabled:
 
3642
            client.init_checker(randomize_start=True)
 
3643
 
 
3644
    tcp_server.enable()
 
3645
    tcp_server.server_activate()
 
3646
 
796
3647
    # Find out what port we got
797
 
    service.port = tcp_server.socket.getsockname()[1]
798
 
    logger.debug(u"Now listening on address %r, port %d, flowinfo %d,"
799
 
                 u" scope_id %d" % tcp_server.socket.getsockname())
800
 
    
801
 
    #service.interface = tcp_server.socket.getsockname()[3]
802
 
    
 
3648
    if zeroconf:
 
3649
        service.port = tcp_server.socket.getsockname()[1]
 
3650
    if use_ipv6:
 
3651
        log.info("Now listening on address %r, port %d, flowinfo %d,"
 
3652
                 " scope_id %d", *tcp_server.socket.getsockname())
 
3653
    else:                       # IPv4
 
3654
        log.info("Now listening on address %r, port %d",
 
3655
                 *tcp_server.socket.getsockname())
 
3656
 
 
3657
    # service.interface = tcp_server.socket.getsockname()[3]
 
3658
 
803
3659
    try:
804
 
        # From the Avahi example code
805
 
        server.connect_to_signal("StateChanged", server_state_changed)
806
 
        try:
807
 
            server_state_changed(server.GetState())
808
 
        except dbus.exceptions.DBusException, error:
809
 
            logger.critical(u"DBusException: %s", error)
810
 
            sys.exit(1)
811
 
        # End of Avahi example code
812
 
        
813
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
814
 
                             lambda *args, **kwargs:
815
 
                             tcp_server.handle_request\
816
 
                             (*args[2:], **kwargs) or True)
817
 
        
818
 
        logger.debug("Starting main loop")
819
 
        main_loop_started = True
 
3660
        if zeroconf:
 
3661
            # From the Avahi example code
 
3662
            try:
 
3663
                service.activate()
 
3664
            except dbus.exceptions.DBusException as error:
 
3665
                log.critical("D-Bus Exception", exc_info=error)
 
3666
                cleanup()
 
3667
                sys.exit(1)
 
3668
            # End of Avahi example code
 
3669
 
 
3670
        GLib.io_add_watch(
 
3671
            GLib.IOChannel.unix_new(tcp_server.fileno()),
 
3672
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
3673
            lambda *args, **kwargs: (tcp_server.handle_request
 
3674
                                     (*args[2:], **kwargs) or True))
 
3675
 
 
3676
        log.debug("Starting main loop")
820
3677
        main_loop.run()
821
 
    except AvahiError, error:
822
 
        logger.critical(u"AvahiError: %s" + unicode(error))
 
3678
    except AvahiError as error:
 
3679
        log.critical("Avahi Error", exc_info=error)
 
3680
        cleanup()
823
3681
        sys.exit(1)
824
3682
    except KeyboardInterrupt:
825
3683
        if debug:
826
 
            print
827
 
 
828
 
if __name__ == '__main__':
829
 
    main()
 
3684
            print("", file=sys.stderr)
 
3685
        log.debug("Server received KeyboardInterrupt")
 
3686
    log.debug("Server exiting")
 
3687
    # Must run before the D-Bus bus name gets deregistered
 
3688
    cleanup()
 
3689
 
 
3690
 
 
3691
def parse_test_args():
 
3692
    # type: () -> argparse.Namespace
 
3693
    parser = argparse.ArgumentParser(add_help=False)
 
3694
    parser.add_argument("--check", action="store_true")
 
3695
    parser.add_argument("--prefix", )
 
3696
    args, unknown_args = parser.parse_known_args()
 
3697
    if args.check:
 
3698
        # Remove test options from sys.argv
 
3699
        sys.argv[1:] = unknown_args
 
3700
    return args
 
3701
 
 
3702
# Add all tests from doctest strings
 
3703
def load_tests(loader, tests, none):
 
3704
    import doctest
 
3705
    tests.addTests(doctest.DocTestSuite())
 
3706
    return tests
 
3707
 
 
3708
if __name__ == "__main__":
 
3709
    options = parse_test_args()
 
3710
    try:
 
3711
        if options.check:
 
3712
            extra_test_prefix = options.prefix
 
3713
            if extra_test_prefix is not None:
 
3714
                if not (unittest.main(argv=[""], exit=False)
 
3715
                        .result.wasSuccessful()):
 
3716
                    sys.exit(1)
 
3717
                class ExtraTestLoader(unittest.TestLoader):
 
3718
                    testMethodPrefix = extra_test_prefix
 
3719
                # Call using ./scriptname --test [--verbose]
 
3720
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
 
3721
            else:
 
3722
                unittest.main(argv=[""])
 
3723
        else:
 
3724
            main()
 
3725
    finally:
 
3726
        logging.shutdown()
 
3727
 
 
3728
# Local Variables:
 
3729
# run-tests:
 
3730
# (lambda (&optional extra)
 
3731
#   (if (not (funcall run-tests-in-test-buffer default-directory
 
3732
#             extra))
 
3733
#       (funcall show-test-buffer-in-test-window)
 
3734
#     (funcall remove-test-window)
 
3735
#     (if extra (message "Extra tests run successfully!"))))
 
3736
# run-tests-in-test-buffer:
 
3737
# (lambda (dir &optional extra)
 
3738
#   (with-current-buffer (get-buffer-create "*Test*")
 
3739
#     (setq buffer-read-only nil
 
3740
#           default-directory dir)
 
3741
#     (erase-buffer)
 
3742
#     (compilation-mode))
 
3743
#   (let ((process-result
 
3744
#          (let ((inhibit-read-only t))
 
3745
#            (process-file-shell-command
 
3746
#             (funcall get-command-line extra) nil "*Test*"))))
 
3747
#     (and (numberp process-result)
 
3748
#          (= process-result 0))))
 
3749
# get-command-line:
 
3750
# (lambda (&optional extra)
 
3751
#   (let ((quoted-script
 
3752
#          (shell-quote-argument (funcall get-script-name))))
 
3753
#     (format
 
3754
#      (concat "%s --check" (if extra " --prefix=atest" ""))
 
3755
#      quoted-script)))
 
3756
# get-script-name:
 
3757
# (lambda ()
 
3758
#   (if (fboundp 'file-local-name)
 
3759
#       (file-local-name (buffer-file-name))
 
3760
#     (or (file-remote-p (buffer-file-name) 'localname)
 
3761
#         (buffer-file-name))))
 
3762
# remove-test-window:
 
3763
# (lambda ()
 
3764
#   (let ((test-window (get-buffer-window "*Test*")))
 
3765
#     (if test-window (delete-window test-window))))
 
3766
# show-test-buffer-in-test-window:
 
3767
# (lambda ()
 
3768
#   (when (not (get-buffer-window-list "*Test*"))
 
3769
#     (setq next-error-last-buffer (get-buffer "*Test*"))
 
3770
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
 
3771
#            (display-buffer-overriding-action
 
3772
#             `((display-buffer-in-side-window) (side . ,side)
 
3773
#               (window-height . fit-window-to-buffer)
 
3774
#               (window-width . fit-window-to-buffer))))
 
3775
#       (display-buffer "*Test*"))))
 
3776
# eval:
 
3777
# (progn
 
3778
#   (let* ((run-extra-tests (lambda () (interactive)
 
3779
#                             (funcall run-tests t)))
 
3780
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
 
3781
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
 
3782
#     (setq minor-mode-overriding-map-alist
 
3783
#           (cons `(run-tests . ,outer-keymap)
 
3784
#                 minor-mode-overriding-map-alist)))
 
3785
#   (add-hook 'after-save-hook run-tests 90 t))
 
3786
# End: